drivers/media/dvb/dvb-usb/anysee.h

   1 /*
   2  * DVB USB Linux driver for Anysee E30 DVB-C & DVB-T USB2.0 receiver
   3  *
   4  * Copyright (C) 2007 Antti Palosaari <crope@iki.fi>
   5  *
   6  *    This program is free software; you can redistribute it and/or modify
   7  *    it under the terms of the GNU General Public License as published by
   8  *    the Free Software Foundation; either version 2 of the License, or
   9  *    (at your option) any later version.
  10  *
  11  *    This program is distributed in the hope that it will be useful,
  12  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *    GNU General Public License for more details.
  15  *
  16  *    You should have received a copy of the GNU General Public License
  17  *    along with this program; if not, write to the Free Software
  18  *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  * TODO:
  21  * - add smart card reader support for Conditional Access (CA)
  22  *
  23  * Card reader in Anysee is nothing more than ISO 7816 card reader.
  24  * There is no hardware CAM in any Anysee device sold.
  25  * In my understanding it should be implemented by making own module
  26  * for ISO 7816 card reader, like dvb_ca_en50221 is implemented. This
  27  * module registers serial interface that can be used to communicate
  28  * with any ISO 7816 smart card.
  29  *
  30  * Any help according to implement serial smart card reader support
  31  * is highly welcome!
  32  */
  33
  34 #ifndef _DVB_USB_ANYSEE_H_
  35 #define _DVB_USB_ANYSEE_H_
  36
  37 #define DVB_USB_LOG_PREFIX "anysee"
  38 #include "dvb-usb.h"
  39
  40 #define deb_info(args...) dprintk(dvb_usb_anysee_debug, 0x01, args)
  41 #define deb_xfer(args...) dprintk(dvb_usb_anysee_debug, 0x02, args)
  42 #define deb_rc(args...)   dprintk(dvb_usb_anysee_debug, 0x04, args)
  43 #define deb_reg(args...)  dprintk(dvb_usb_anysee_debug, 0x08, args)
  44 #define deb_i2c(args...)  dprintk(dvb_usb_anysee_debug, 0x10, args)
  45 #define deb_fw(args...)   dprintk(dvb_usb_anysee_debug, 0x20, args)
  46
  47 enum cmd {
  48         CMD_I2C_READ            = 0x33,
  49         CMD_I2C_WRITE           = 0x31,
  50         CMD_REG_READ            = 0xb0,
  51         CMD_REG_WRITE           = 0xb1,
  52         CMD_STREAMING_CTRL      = 0x12,
  53         CMD_LED_AND_IR_CTRL     = 0x16,
  54         CMD_GET_IR_CODE         = 0x41,
  55         CMD_GET_HW_INFO         = 0x19,
  56         CMD_SMARTCARD           = 0x34,
  57 };
  58
  59 struct anysee_state {
  60         u8 hw; /* PCB ID */
  61         u8 seq;
  62         u8 fe_id:1; /* frondend ID */
  63 };
  64
  65 #define ANYSEE_HW_507T    2 /* E30 */
  66 #define ANYSEE_HW_507CD   6 /* E30 Plus */
  67 #define ANYSEE_HW_507DC  10 /* E30 C Plus */
  68 #define ANYSEE_HW_507SI  11 /* E30 S2 Plus */
  69 #define ANYSEE_HW_507FA  15 /* E30 Combo Plus / E30 C Plus */
  70 #define ANYSEE_HW_508TC  18 /* E7 TC */
  71 #define ANYSEE_HW_508S2  19 /* E7 S2 */
  72 #define ANYSEE_HW_508PTC 21 /* E7 PTC Plus */
  73 #define ANYSEE_HW_508PS2 22 /* E7 PS2 Plus */
  74
  75 #define REG_IOA       0x80 /* Port A (bit addressable) */
  76 #define REG_IOB       0x90 /* Port B (bit addressable) */
  77 #define REG_IOC       0xa0 /* Port C (bit addressable) */
  78 #define REG_IOD       0xb0 /* Port D (bit addressable) */
  79 #define REG_IOE       0xb1 /* Port E (NOT bit addressable) */
  80 #define REG_OEA       0xb2 /* Port A Output Enable */
  81 #define REG_OEB       0xb3 /* Port B Output Enable */
  82 #define REG_OEC       0xb4 /* Port C Output Enable */
  83 #define REG_OED       0xb5 /* Port D Output Enable */
  84 #define REG_OEE       0xb6 /* Port E Output Enable */
  85
  86 #endif
  87
  88 /***************************************************************************
  89  * USB API description (reverse engineered)
  90  ***************************************************************************
  91
  92 Transaction flow:
  93 =================
  94 BULK[00001] >>> REQUEST PACKET 64 bytes
  95 BULK[00081] <<< REPLY PACKET #1 64 bytes (PREVIOUS TRANSACTION REPLY)
  96 BULK[00081] <<< REPLY PACKET #2 64 bytes (CURRENT TRANSACTION REPLY)
  97
  98 General reply packet(s) are always used if not own reply defined.
  99
 100 ============================================================================
 101 | 00-63 | GENERAL REPLY PACKET #1 (PREVIOUS REPLY)
 102 ============================================================================
 103 |    00 | reply data (if any) from previous transaction
 104 |       | Just same reply packet as returned during previous transaction.
 105 |       | Needed only if reply is missed in previous transaction.
 106 |       | Just skip normally.
 107 ----------------------------------------------------------------------------
 108 | 01-59 | don't care
 109 ----------------------------------------------------------------------------
 110 |    60 | packet sequence number
 111 ----------------------------------------------------------------------------
 112 | 61-63 | don't care
 113 ----------------------------------------------------------------------------
 114
 115 ============================================================================
 116 | 00-63 | GENERAL REPLY PACKET #2 (CURRENT REPLY)
 117 ============================================================================
 118 |    00 | reply data (if any)
 119 ----------------------------------------------------------------------------
 120 | 01-59 | don't care
 121 ----------------------------------------------------------------------------
 122 |    60 | packet sequence number
 123 ----------------------------------------------------------------------------
 124 | 61-63 | don't care
 125 ----------------------------------------------------------------------------
 126
 127 ============================================================================
 128 | 00-63 | I2C WRITE REQUEST PACKET
 129 ============================================================================
 130 |    00 | 0x31 I2C write command
 131 ----------------------------------------------------------------------------
 132 |    01 | i2c address
 133 ----------------------------------------------------------------------------
 134 |    02 | data length
 135 |       | 0x02 (for typical I2C reg / val pair)
 136 ----------------------------------------------------------------------------
 137 |    03 | 0x01
 138 ----------------------------------------------------------------------------
 139 | 04-   | data
 140 ----------------------------------------------------------------------------
 141 |   -59 | don't care
 142 ----------------------------------------------------------------------------
 143 |    60 | packet sequence number
 144 ----------------------------------------------------------------------------
 145 | 61-63 | don't care
 146 ----------------------------------------------------------------------------
 147
 148 ============================================================================
 149 | 00-63 | I2C READ REQUEST PACKET
 150 ============================================================================
 151 |    00 | 0x33 I2C read command
 152 ----------------------------------------------------------------------------
 153 |    01 | i2c address + 1
 154 ----------------------------------------------------------------------------
 155 |    02 | register
 156 ----------------------------------------------------------------------------
 157 |    03 | 0x00
 158 ----------------------------------------------------------------------------
 159 |    04 | 0x00
 160 ----------------------------------------------------------------------------
 161 |    05 | data length
 162 ----------------------------------------------------------------------------
 163 | 06-59 | don't care
 164 ----------------------------------------------------------------------------
 165 |    60 | packet sequence number
 166 ----------------------------------------------------------------------------
 167 | 61-63 | don't care
 168 ----------------------------------------------------------------------------
 169
 170 ============================================================================
 171 | 00-63 | USB CONTROLLER REGISTER WRITE REQUEST PACKET
 172 ============================================================================
 173 |    00 | 0xb1 register write command
 174 ----------------------------------------------------------------------------
 175 | 01-02 | register
 176 ----------------------------------------------------------------------------
 177 |    03 | 0x01
 178 ----------------------------------------------------------------------------
 179 |    04 | value
 180 ----------------------------------------------------------------------------
 181 | 05-59 | don't care
 182 ----------------------------------------------------------------------------
 183 |    60 | packet sequence number
 184 ----------------------------------------------------------------------------
 185 | 61-63 | don't care
 186 ----------------------------------------------------------------------------
 187
 188 ============================================================================
 189 | 00-63 | USB CONTROLLER REGISTER READ REQUEST PACKET
 190 ============================================================================
 191 |    00 | 0xb0 register read command
 192 ----------------------------------------------------------------------------
 193 | 01-02 | register
 194 ----------------------------------------------------------------------------
 195 |    03 | 0x01
 196 ----------------------------------------------------------------------------
 197 | 04-59 | don't care
 198 ----------------------------------------------------------------------------
 199 |    60 | packet sequence number
 200 ----------------------------------------------------------------------------
 201 | 61-63 | don't care
 202 ----------------------------------------------------------------------------
 203
 204 ============================================================================
 205 | 00-63 | LED CONTROL REQUEST PACKET
 206 ============================================================================
 207 |    00 | 0x16 LED and IR control command
 208 ----------------------------------------------------------------------------
 209 |    01 | 0x01 (LED)
 210 ----------------------------------------------------------------------------
 211 |    03 | 0x00 blink
 212 |       | 0x01 lights continuously
 213 ----------------------------------------------------------------------------
 214 |    04 | blink interval
 215 |       | 0x00 fastest (looks like LED lights continuously)
 216 |       | 0xff slowest
 217 ----------------------------------------------------------------------------
 218 | 05-59 | don't care
 219 ----------------------------------------------------------------------------
 220 |    60 | packet sequence number
 221 ----------------------------------------------------------------------------
 222 | 61-63 | don't care
 223 ----------------------------------------------------------------------------
 224
 225 ============================================================================
 226 | 00-63 | IR CONTROL REQUEST PACKET
 227 ============================================================================
 228 |    00 | 0x16 LED and IR control command
 229 ----------------------------------------------------------------------------
 230 |    01 | 0x02 (IR)
 231 ----------------------------------------------------------------------------
 232 |    03 | 0x00 IR disabled
 233 |       | 0x01 IR enabled
 234 ----------------------------------------------------------------------------
 235 | 04-59 | don't care
 236 ----------------------------------------------------------------------------
 237 |    60 | packet sequence number
 238 ----------------------------------------------------------------------------
 239 | 61-63 | don't care
 240 ----------------------------------------------------------------------------
 241
 242 ============================================================================
 243 | 00-63 | STREAMING CONTROL REQUEST PACKET
 244 ============================================================================
 245 |    00 | 0x12 streaming control command
 246 ----------------------------------------------------------------------------
 247 |    01 | 0x00 streaming disabled
 248 |       | 0x01 streaming enabled
 249 ----------------------------------------------------------------------------
 250 |    02 | 0x00
 251 ----------------------------------------------------------------------------
 252 | 03-59 | don't care
 253 ----------------------------------------------------------------------------
 254 |    60 | packet sequence number
 255 ----------------------------------------------------------------------------
 256 | 61-63 | don't care
 257 ----------------------------------------------------------------------------
 258
 259 ============================================================================
 260 | 00-63 | REMOTE CONTROL REQUEST PACKET
 261 ============================================================================
 262 |    00 | 0x41 remote control command
 263 ----------------------------------------------------------------------------
 264 | 01-59 | don't care
 265 ----------------------------------------------------------------------------
 266 |    60 | packet sequence number
 267 ----------------------------------------------------------------------------
 268 | 61-63 | don't care
 269 ----------------------------------------------------------------------------
 270
 271 ============================================================================
 272 | 00-63 | REMOTE CONTROL REPLY PACKET
 273 ============================================================================
 274 |    00 | 0x00 code not received
 275 |       | 0x01 code received
 276 ----------------------------------------------------------------------------
 277 |    01 | remote control code
 278 ----------------------------------------------------------------------------
 279 | 02-59 | don't care
 280 ----------------------------------------------------------------------------
 281 |    60 | packet sequence number
 282 ----------------------------------------------------------------------------
 283 | 61-63 | don't care
 284 ----------------------------------------------------------------------------
 285
 286 ============================================================================
 287 | 00-63 | GET HARDWARE INFO REQUEST PACKET
 288 ============================================================================
 289 |    00 | 0x19 get hardware info command
 290 ----------------------------------------------------------------------------
 291 | 01-59 | don't care
 292 ----------------------------------------------------------------------------
 293 |    60 | packet sequence number
 294 ----------------------------------------------------------------------------
 295 | 61-63 | don't care
 296 ----------------------------------------------------------------------------
 297
 298 ============================================================================
 299 | 00-63 | GET HARDWARE INFO REPLY PACKET
 300 ============================================================================
 301 |    00 | hardware id
 302 ----------------------------------------------------------------------------
 303 | 01-02 | firmware version
 304 ----------------------------------------------------------------------------
 305 | 03-59 | don't care
 306 ----------------------------------------------------------------------------
 307 |    60 | packet sequence number
 308 ----------------------------------------------------------------------------
 309 | 61-63 | don't care
 310 ----------------------------------------------------------------------------
 311
 312 ============================================================================
 313 | 00-63 | SMART CARD READER PACKET
 314 ============================================================================
 315 |    00 | 0x34 smart card reader command
 316 ----------------------------------------------------------------------------
 317 |    xx |
 318 ----------------------------------------------------------------------------
 319 | xx-59 | don't care
 320 ----------------------------------------------------------------------------
 321 |    60 | packet sequence number
 322 ----------------------------------------------------------------------------
 323 | 61-63 | don't care
 324 ----------------------------------------------------------------------------
 325
 326 */