drivers/net/wireless/rt2x00/rt2x00usb.h

   1 /*
   2         Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
   3         <http://rt2x00.serialmonkey.com>
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 /*
  20         Module: rt2x00usb
  21         Abstract: Data structures for the rt2x00usb module.
  22  */
  23
  24 #ifndef RT2X00USB_H
  25 #define RT2X00USB_H
  26
  27 #include <linux/usb.h>
  28
  29 #define to_usb_device_intf(d) \
  30 ({ \
  31         struct usb_interface *intf = to_usb_interface(d); \
  32         interface_to_usbdev(intf); \
  33 })
  34
  35 /*
  36  * For USB vendor requests we need to pass a timeout
  37  * time in ms, for this we use the REGISTER_TIMEOUT,
  38  * however when loading firmware a higher value is
  39  * required. In that case we use the REGISTER_TIMEOUT_FIRMWARE.
  40  */
  41 #define REGISTER_TIMEOUT                500
  42 #define REGISTER_TIMEOUT_FIRMWARE       1000
  43
  44 /**
  45  * REGISTER_TIMEOUT16 - Determine the timeout for 16bit register access
  46  * @__datalen: Data length
  47  */
  48 #define REGISTER_TIMEOUT16(__datalen)   \
  49         ( REGISTER_TIMEOUT * ((__datalen) / sizeof(u16)) )
  50
  51 /**
  52  * REGISTER_TIMEOUT32 - Determine the timeout for 32bit register access
  53  * @__datalen: Data length
  54  */
  55 #define REGISTER_TIMEOUT32(__datalen)   \
  56         ( REGISTER_TIMEOUT * ((__datalen) / sizeof(u32)) )
  57
  58 /*
  59  * Cache size
  60  */
  61 #define CSR_CACHE_SIZE                  64
  62
  63 /*
  64  * USB request types.
  65  */
  66 #define USB_VENDOR_REQUEST      ( USB_TYPE_VENDOR | USB_RECIP_DEVICE )
  67 #define USB_VENDOR_REQUEST_IN   ( USB_DIR_IN | USB_VENDOR_REQUEST )
  68 #define USB_VENDOR_REQUEST_OUT  ( USB_DIR_OUT | USB_VENDOR_REQUEST )
  69
  70 /**
  71  * enum rt2x00usb_vendor_request: USB vendor commands.
  72  */
  73 enum rt2x00usb_vendor_request {
  74         USB_DEVICE_MODE = 1,
  75         USB_SINGLE_WRITE = 2,
  76         USB_SINGLE_READ = 3,
  77         USB_MULTI_WRITE = 6,
  78         USB_MULTI_READ = 7,
  79         USB_EEPROM_WRITE = 8,
  80         USB_EEPROM_READ = 9,
  81         USB_LED_CONTROL = 10, /* RT73USB */
  82         USB_RX_CONTROL = 12,
  83 };
  84
  85 /**
  86  * enum rt2x00usb_mode_offset: Device modes offset.
  87  */
  88 enum rt2x00usb_mode_offset {
  89         USB_MODE_RESET = 1,
  90         USB_MODE_UNPLUG = 2,
  91         USB_MODE_FUNCTION = 3,
  92         USB_MODE_TEST = 4,
  93         USB_MODE_SLEEP = 7,     /* RT73USB */
  94         USB_MODE_FIRMWARE = 8,  /* RT73USB */
  95         USB_MODE_WAKEUP = 9,    /* RT73USB */
  96 };
  97
  98 /**
  99  * rt2x00usb_vendor_request - Send register command to device
 100  * @rt2x00dev: Pointer to &struct rt2x00_dev
 101  * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
 102  * @requesttype: Request type &USB_VENDOR_REQUEST_*
 103  * @offset: Register offset to perform action on
 104  * @value: Value to write to device
 105  * @buffer: Buffer where information will be read/written to by device
 106  * @buffer_length: Size of &buffer
 107  * @timeout: Operation timeout
 108  *
 109  * This is the main function to communicate with the device,
 110  * the &buffer argument _must_ either be NULL or point to
 111  * a buffer allocated by kmalloc. Failure to do so can lead
 112  * to unexpected behavior depending on the architecture.
 113  */
 114 int rt2x00usb_vendor_request(struct rt2x00_dev *rt2x00dev,
 115                              const u8 request, const u8 requesttype,
 116                              const u16 offset, const u16 value,
 117                              void *buffer, const u16 buffer_length,
 118                              const int timeout);
 119
 120 /**
 121  * rt2x00usb_vendor_request_buff - Send register command to device (buffered)
 122  * @rt2x00dev: Pointer to &struct rt2x00_dev
 123  * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
 124  * @requesttype: Request type &USB_VENDOR_REQUEST_*
 125  * @offset: Register offset to perform action on
 126  * @buffer: Buffer where information will be read/written to by device
 127  * @buffer_length: Size of &buffer
 128  * @timeout: Operation timeout
 129  *
 130  * This function will use a previously with kmalloc allocated cache
 131  * to communicate with the device. The contents of the buffer pointer
 132  * will be copied to this cache when writing, or read from the cache
 133  * when reading.
 134  * Buffers send to &rt2x00usb_vendor_request _must_ be allocated with
 135  * kmalloc. Hence the reason for using a previously allocated cache
 136  * which has been allocated properly.
 137  */
 138 int rt2x00usb_vendor_request_buff(struct rt2x00_dev *rt2x00dev,
 139                                   const u8 request, const u8 requesttype,
 140                                   const u16 offset, void *buffer,
 141                                   const u16 buffer_length, const int timeout);
 142
 143 /**
 144  * rt2x00usb_vendor_request_buff - Send register command to device (buffered)
 145  * @rt2x00dev: Pointer to &struct rt2x00_dev
 146  * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
 147  * @requesttype: Request type &USB_VENDOR_REQUEST_*
 148  * @offset: Register offset to perform action on
 149  * @buffer: Buffer where information will be read/written to by device
 150  * @buffer_length: Size of &buffer
 151  * @timeout: Operation timeout
 152  *
 153  * A version of &rt2x00usb_vendor_request_buff which must be called
 154  * if the usb_cache_mutex is already held.
 155  */
 156 int rt2x00usb_vendor_req_buff_lock(struct rt2x00_dev *rt2x00dev,
 157                                    const u8 request, const u8 requesttype,
 158                                    const u16 offset, void *buffer,
 159                                    const u16 buffer_length, const int timeout);
 160
 161 /**
 162  * rt2x00usb_vendor_request_sw - Send single register command to device
 163  * @rt2x00dev: Pointer to &struct rt2x00_dev
 164  * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
 165  * @offset: Register offset to perform action on
 166  * @value: Value to write to device
 167  * @timeout: Operation timeout
 168  *
 169  * Simple wrapper around rt2x00usb_vendor_request to write a single
 170  * command to the device. Since we don't use the buffer argument we
 171  * don't have to worry about kmalloc here.
 172  */
 173 static inline int rt2x00usb_vendor_request_sw(struct rt2x00_dev *rt2x00dev,
 174                                               const u8 request,
 175                                               const u16 offset,
 176                                               const u16 value,
 177                                               const int timeout)
 178 {
 179         return rt2x00usb_vendor_request(rt2x00dev, request,
 180                                         USB_VENDOR_REQUEST_OUT, offset,
 181                                         value, NULL, 0, timeout);
 182 }
 183
 184 /**
 185  * rt2x00usb_eeprom_read - Read eeprom from device
 186  * @rt2x00dev: Pointer to &struct rt2x00_dev
 187  * @eeprom: Pointer to eeprom array to store the information in
 188  * @length: Number of bytes to read from the eeprom
 189  *
 190  * Simple wrapper around rt2x00usb_vendor_request to read the eeprom
 191  * from the device. Note that the eeprom argument _must_ be allocated using
 192  * kmalloc for correct handling inside the kernel USB layer.
 193  */
 194 static inline int rt2x00usb_eeprom_read(struct rt2x00_dev *rt2x00dev,
 195                                         __le16 *eeprom, const u16 length)
 196 {
 197         return rt2x00usb_vendor_request(rt2x00dev, USB_EEPROM_READ,
 198                                         USB_VENDOR_REQUEST_IN, 0, 0,
 199                                         eeprom, length,
 200                                         REGISTER_TIMEOUT16(length));
 201 }
 202
 203 /**
 204  * rt2x00usb_register_read - Read 32bit register word
 205  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 206  * @offset: Register offset
 207  * @value: Pointer to where register contents should be stored
 208  *
 209  * This function is a simple wrapper for 32bit register access
 210  * through rt2x00usb_vendor_request_buff().
 211  */
 212 static inline void rt2x00usb_register_read(struct rt2x00_dev *rt2x00dev,
 213                                            const unsigned int offset,
 214                                            u32 *value)
 215 {
 216         __le32 reg;
 217         rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_READ,
 218                                       USB_VENDOR_REQUEST_IN, offset,
 219                                       &reg, sizeof(reg), REGISTER_TIMEOUT);
 220         *value = le32_to_cpu(reg);
 221 }
 222
 223 /**
 224  * rt2x00usb_register_read_lock - Read 32bit register word
 225  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 226  * @offset: Register offset
 227  * @value: Pointer to where register contents should be stored
 228  *
 229  * This function is a simple wrapper for 32bit register access
 230  * through rt2x00usb_vendor_req_buff_lock().
 231  */
 232 static inline void rt2x00usb_register_read_lock(struct rt2x00_dev *rt2x00dev,
 233                                                 const unsigned int offset,
 234                                                 u32 *value)
 235 {
 236         __le32 reg;
 237         rt2x00usb_vendor_req_buff_lock(rt2x00dev, USB_MULTI_READ,
 238                                        USB_VENDOR_REQUEST_IN, offset,
 239                                        &reg, sizeof(reg), REGISTER_TIMEOUT);
 240         *value = le32_to_cpu(reg);
 241 }
 242
 243 /**
 244  * rt2x00usb_register_multiread - Read 32bit register words
 245  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 246  * @offset: Register offset
 247  * @value: Pointer to where register contents should be stored
 248  * @length: Length of the data
 249  *
 250  * This function is a simple wrapper for 32bit register access
 251  * through rt2x00usb_vendor_request_buff().
 252  */
 253 static inline void rt2x00usb_register_multiread(struct rt2x00_dev *rt2x00dev,
 254                                                 const unsigned int offset,
 255                                                 void *value, const u32 length)
 256 {
 257         rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_READ,
 258                                       USB_VENDOR_REQUEST_IN, offset,
 259                                       value, length,
 260                                       REGISTER_TIMEOUT32(length));
 261 }
 262
 263 /**
 264  * rt2x00usb_register_write - Write 32bit register word
 265  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 266  * @offset: Register offset
 267  * @value: Data which should be written
 268  *
 269  * This function is a simple wrapper for 32bit register access
 270  * through rt2x00usb_vendor_request_buff().
 271  */
 272 static inline void rt2x00usb_register_write(struct rt2x00_dev *rt2x00dev,
 273                                             const unsigned int offset,
 274                                             u32 value)
 275 {
 276         __le32 reg = cpu_to_le32(value);
 277         rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_WRITE,
 278                                       USB_VENDOR_REQUEST_OUT, offset,
 279                                       &reg, sizeof(reg), REGISTER_TIMEOUT);
 280 }
 281
 282 /**
 283  * rt2x00usb_register_write_lock - Write 32bit register word
 284  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 285  * @offset: Register offset
 286  * @value: Data which should be written
 287  *
 288  * This function is a simple wrapper for 32bit register access
 289  * through rt2x00usb_vendor_req_buff_lock().
 290  */
 291 static inline void rt2x00usb_register_write_lock(struct rt2x00_dev *rt2x00dev,
 292                                                  const unsigned int offset,
 293                                                  u32 value)
 294 {
 295         __le32 reg = cpu_to_le32(value);
 296         rt2x00usb_vendor_req_buff_lock(rt2x00dev, USB_MULTI_WRITE,
 297                                        USB_VENDOR_REQUEST_OUT, offset,
 298                                        &reg, sizeof(reg), REGISTER_TIMEOUT);
 299 }
 300
 301 /**
 302  * rt2x00usb_register_multiwrite - Write 32bit register words
 303  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 304  * @offset: Register offset
 305  * @value: Data which should be written
 306  * @length: Length of the data
 307  *
 308  * This function is a simple wrapper for 32bit register access
 309  * through rt2x00usb_vendor_request_buff().
 310  */
 311 static inline void rt2x00usb_register_multiwrite(struct rt2x00_dev *rt2x00dev,
 312                                                  const unsigned int offset,
 313                                                  const void *value,
 314                                                  const u32 length)
 315 {
 316         rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_WRITE,
 317                                       USB_VENDOR_REQUEST_OUT, offset,
 318                                       (void *)value, length,
 319                                       REGISTER_TIMEOUT32(length));
 320 }
 321
 322 /**
 323  * rt2x00usb_regbusy_read - Read from register with busy check
 324  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 325  * @offset: Register offset
 326  * @field: Field to check if register is busy
 327  * @reg: Pointer to where register contents should be stored
 328  *
 329  * This function will read the given register, and checks if the
 330  * register is busy. If it is, it will sleep for a couple of
 331  * microseconds before reading the register again. If the register
 332  * is not read after a certain timeout, this function will return
 333  * FALSE.
 334  */
 335 int rt2x00usb_regbusy_read(struct rt2x00_dev *rt2x00dev,
 336                            const unsigned int offset,
 337                            const struct rt2x00_field32 field,
 338                            u32 *reg);
 339
 340 /**
 341  * rt2x00usb_register_read_async - Asynchronously read 32bit register word
 342  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 343  * @offset: Register offset
 344  * @callback: Functon to call when read completes.
 345  *
 346  * Submit a control URB to read a 32bit register. This safe to
 347  * be called from atomic context.  The callback will be called
 348  * when the URB completes. Otherwise the function is similar
 349  * to rt2x00usb_register_read().
 350  * When the callback function returns false, the memory will be cleaned up,
 351  * when it returns true, the urb will be fired again.
 352  */
 353 void rt2x00usb_register_read_async(struct rt2x00_dev *rt2x00dev,
 354                                    const unsigned int offset,
 355                                    bool (*callback)(struct rt2x00_dev*, int, u32));
 356
 357 /*
 358  * Radio handlers
 359  */
 360 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev);
 361
 362 /**
 363  * struct queue_entry_priv_usb: Per entry USB specific information
 364  *
 365  * @urb: Urb structure used for device communication.
 366  */
 367 struct queue_entry_priv_usb {
 368         struct urb *urb;
 369 };
 370
 371 /**
 372  * struct queue_entry_priv_usb_bcn: Per TX entry USB specific information
 373  *
 374  * The first section should match &struct queue_entry_priv_usb exactly.
 375  * rt2500usb can use this structure to send a guardian byte when working
 376  * with beacons.
 377  *
 378  * @urb: Urb structure used for device communication.
 379  * @guardian_data: Set to 0, used for sending the guardian data.
 380  * @guardian_urb: Urb structure used to send the guardian data.
 381  */
 382 struct queue_entry_priv_usb_bcn {
 383         struct urb *urb;
 384
 385         unsigned int guardian_data;
 386         struct urb *guardian_urb;
 387 };
 388
 389 /**
 390  * rt2x00usb_kick_queue - Kick data queue
 391  * @queue: Data queue to kick
 392  *
 393  * This will walk through all entries of the queue and push all pending
 394  * frames to the hardware as a single burst.
 395  */
 396 void rt2x00usb_kick_queue(struct data_queue *queue);
 397
 398 /**
 399  * rt2x00usb_flush_queue - Flush data queue
 400  * @queue: Data queue to stop
 401  * @drop: True to drop all pending frames.
 402  *
 403  * This will walk through all entries of the queue and will optionally
 404  * kill all URB's which were send to the device, or at least wait until
 405  * they have been returned from the device..
 406  */
 407 void rt2x00usb_flush_queue(struct data_queue *queue, bool drop);
 408
 409 /**
 410  * rt2x00usb_watchdog - Watchdog for USB communication
 411  * @rt2x00dev: Pointer to &struct rt2x00_dev
 412  *
 413  * Check the health of the USB communication and determine
 414  * if timeouts have occurred. If this is the case, this function
 415  * will reset all communication to restore functionality again.
 416  */
 417 void rt2x00usb_watchdog(struct rt2x00_dev *rt2x00dev);
 418
 419 /*
 420  * Device initialization handlers.
 421  */
 422 void rt2x00usb_clear_entry(struct queue_entry *entry);
 423 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev);
 424 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev);
 425
 426 /*
 427  * USB driver handlers.
 428  */
 429 int rt2x00usb_probe(struct usb_interface *usb_intf,
 430                     const struct rt2x00_ops *ops);
 431 void rt2x00usb_disconnect(struct usb_interface *usb_intf);
 432 #ifdef CONFIG_PM
 433 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state);
 434 int rt2x00usb_resume(struct usb_interface *usb_intf);
 435 #else
 436 #define rt2x00usb_suspend       NULL
 437 #define rt2x00usb_resume        NULL
 438 #endif /* CONFIG_PM */
 439
 440 #endif /* RT2X00USB_H */