2 * carl9170 firmware - used by the ar9170 wireless device
6 * Copyright (c) 2000-2005 ZyDAS Technology Corporation
7 * Copyright (c) 2007-2009 Atheros Communications, Inc.
8 * Copyright 2009 Johannes Berg <johannes@sipsolutions.net>
9 * Copyright 2009-2011 Christian Lamparter <chunkeey@googlemail.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
31 * NB: The firmware has to write into these structures
32 * so don't try to make them "const".
35 static struct ar9170_usb_config usb_config_highspeed = {
37 .bLength = USB_DT_CONFIG_SIZE,
38 .bDescriptorType = USB_DT_CONFIG,
39 .wTotalLength = cpu_to_le16(sizeof(usb_config_highspeed)),
41 .bConfigurationValue = 1,
43 .bmAttributes = USB_CONFIG_ATT_ONE |
44 #ifdef CONFIG_CARL9170FW_WOL
45 USB_CONFIG_ATT_WAKEUP |
46 #endif /* CONFIG_CARL9170FW_WOL */
48 .bMaxPower = 0xfa, /* 500 mA */
52 .bLength = USB_DT_INTERFACE_SIZE,
53 .bDescriptorType = USB_DT_INTERFACE,
54 .bInterfaceNumber = 0,
55 .bAlternateSetting = 0,
56 .bNumEndpoints = AR9170_USB_NUM_EXTRA_EP,
57 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
58 .bInterfaceSubClass = USB_SUBCLASS_VENDOR_SPEC,
59 .bInterfaceProtocol = 0,
65 .bLength = USB_DT_ENDPOINT_SIZE,
66 .bDescriptorType = USB_DT_ENDPOINT,
67 .bEndpointAddress = USB_DIR_OUT | AR9170_USB_EP_TX,
68 .bmAttributes = USB_ENDPOINT_XFER_BULK,
69 .wMaxPacketSize = cpu_to_le16(512),
74 .bLength = USB_DT_ENDPOINT_SIZE,
75 .bDescriptorType = USB_DT_ENDPOINT,
76 .bEndpointAddress = USB_DIR_IN | AR9170_USB_EP_RX,
77 .bmAttributes = USB_ENDPOINT_XFER_BULK,
78 .wMaxPacketSize = cpu_to_le16(512),
83 .bLength = USB_DT_ENDPOINT_SIZE,
84 .bDescriptorType = USB_DT_ENDPOINT,
85 .bEndpointAddress = USB_DIR_IN | AR9170_USB_EP_IRQ,
86 .bmAttributes = USB_ENDPOINT_XFER_INT,
87 .wMaxPacketSize = cpu_to_le16(64),
92 .bLength = USB_DT_ENDPOINT_SIZE,
93 .bDescriptorType = USB_DT_ENDPOINT,
94 .bEndpointAddress = USB_DIR_OUT | AR9170_USB_EP_CMD,
95 .bmAttributes = USB_ENDPOINT_XFER_INT,
96 .wMaxPacketSize = cpu_to_le16(64),
102 static struct ar9170_usb_config usb_config_fullspeed = {
104 .bLength = USB_DT_CONFIG_SIZE,
105 .bDescriptorType = USB_DT_CONFIG,
106 .wTotalLength = cpu_to_le16(sizeof(usb_config_fullspeed)),
108 .bConfigurationValue = 1,
110 .bmAttributes = USB_CONFIG_ATT_ONE |
111 #ifdef CONFIG_CARL9170FW_WOL
112 USB_CONFIG_ATT_WAKEUP |
113 #endif /* CONFIG_CARL9170FW_WOL */
115 .bMaxPower = 0xfa, /* 500 mA */
119 .bLength = USB_DT_INTERFACE_SIZE,
120 .bDescriptorType = USB_DT_INTERFACE,
121 .bInterfaceNumber = 0,
122 .bAlternateSetting = 0,
123 .bNumEndpoints = AR9170_USB_NUM_EXTRA_EP,
124 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
125 .bInterfaceSubClass = USB_SUBCLASS_VENDOR_SPEC,
126 .bInterfaceProtocol = 0,
132 .bLength = USB_DT_ENDPOINT_SIZE,
133 .bDescriptorType = USB_DT_ENDPOINT,
134 .bEndpointAddress = USB_DIR_OUT | AR9170_USB_EP_TX,
135 .bmAttributes = USB_ENDPOINT_XFER_BULK,
136 .wMaxPacketSize = cpu_to_le16(64),
141 .bLength = USB_DT_ENDPOINT_SIZE,
142 .bDescriptorType = USB_DT_ENDPOINT,
143 .bEndpointAddress = USB_DIR_IN | AR9170_USB_EP_RX,
144 .bmAttributes = USB_ENDPOINT_XFER_BULK,
145 .wMaxPacketSize = cpu_to_le16(64),
150 .bLength = USB_DT_ENDPOINT_SIZE,
151 .bDescriptorType = USB_DT_ENDPOINT,
152 .bEndpointAddress = USB_DIR_IN | AR9170_USB_EP_IRQ,
153 .bmAttributes = USB_ENDPOINT_XFER_INT,
154 .wMaxPacketSize = cpu_to_le16(64),
159 .bLength = USB_DT_ENDPOINT_SIZE,
160 .bDescriptorType = USB_DT_ENDPOINT,
161 .bEndpointAddress = USB_DIR_OUT | AR9170_USB_EP_CMD,
162 .bmAttributes = USB_ENDPOINT_XFER_INT,
163 .wMaxPacketSize = cpu_to_le16(64),
169 #ifdef CONFIG_CARL9170FW_USB_MODESWITCH
170 static void usb_reset_eps(void)
174 /* clear all EPs' toggle bit */
175 for (i = 1; i < __AR9170_USB_NUM_MAX_EP; i++) {
176 usb_set_input_ep_toggle(i);
177 usb_clear_input_ep_toggle(i);
181 * NB: I've no idea why this cannot be integrated into the
184 for (i = 1; i < __AR9170_USB_NUM_MAX_EP; i++) {
185 usb_set_output_ep_toggle(i);
186 usb_clear_output_ep_toggle(i);
189 #endif /* CONFIG_CARL9170FW_USB_MODESWITCH */
192 #ifdef CONFIG_CARL9170FW_USB_INIT_FIRMWARE
193 static void usb_pta_init(void)
195 unsigned int usb_dma_ctrl = 0;
196 /* Set PTA mode to USB */
197 andl(AR9170_PTA_REG_DMA_MODE_CTRL,
198 ~AR9170_PTA_DMA_MODE_CTRL_DISABLE_USB);
200 /* Do a software reset to PTA component */
201 orl(AR9170_PTA_REG_DMA_MODE_CTRL, AR9170_PTA_DMA_MODE_CTRL_RESET);
202 andl(AR9170_PTA_REG_DMA_MODE_CTRL, ~AR9170_PTA_DMA_MODE_CTRL_RESET);
204 if (usb_detect_highspeed()) {
205 fw.usb.os_cfg_desc = &usb_config_fullspeed;
206 fw.usb.cfg_desc = &usb_config_highspeed;
208 /* 512 Byte DMA transfers */
209 usb_dma_ctrl |= AR9170_USB_DMA_CTL_HIGH_SPEED;
211 fw.usb.cfg_desc = &usb_config_fullspeed;
212 fw.usb.os_cfg_desc = &usb_config_highspeed;
215 #ifdef CONFIG_CARL9170FW_USB_UP_STREAM
216 # if (CONFIG_CARL9170FW_RX_FRAME_LEN == 4096)
217 usb_dma_ctrl |= AR9170_USB_DMA_CTL_UP_STREAM_4K;
218 # elif (CONFIG_CARL9170FW_RX_FRAME_LEN == 8192)
219 usb_dma_ctrl |= AR9170_USB_DMA_CTL_UP_STREAM_8K;
220 # elif (CONFIG_CARL9170FW_RX_FRAME_LEN == 16384)
221 usb_dma_ctrl |= AR9170_USB_DMA_CTL_UP_STREAM_16K;
222 # elif (CONFIG_CARL9170FW_RX_FRAME_LEN == 32768)
223 usb_dma_ctrl |= AR9170_USB_DMA_CTL_UP_STREAM_32K;
225 # error "Invalid AR9170_RX_FRAME_LEN setting"
228 #else /* CONFIG_CARL9170FW_USB_UP_STREAM */
229 usb_dma_ctrl |= AR9170_USB_DMA_CTL_UP_PACKET_MODE;
230 #endif /* CONFIG_CARL9170FW_USB_UP_STREAM */
232 #ifdef CONFIG_CARL9170FW_USB_DOWN_STREAM
233 /* Enable down stream mode */
234 usb_dma_ctrl |= AR9170_USB_DMA_CTL_DOWN_STREAM;
235 #endif /* CONFIG_CARL9170FW_USB_DOWN_STREAM */
237 #ifdef CONFIG_CARL9170FW_USB_UP_STREAM
238 /* Set the up stream mode maximum aggregate number */
239 set(AR9170_USB_REG_MAX_AGG_UPLOAD, 4);
242 * Set the up stream mode timeout value.
243 * NB: The vendor driver (otus) set 0x80?
245 set(AR9170_USB_REG_UPLOAD_TIME_CTL, 0x80);
246 #endif /* CONFIG_CARL9170FW_USB_UP_STREAM */
248 /* Enable up stream and down stream */
249 usb_dma_ctrl |= AR9170_USB_DMA_CTL_ENABLE_TO_DEVICE |
250 AR9170_USB_DMA_CTL_ENABLE_FROM_DEVICE;
252 set(AR9170_USB_REG_DMA_CTL, usb_dma_ctrl);
254 #endif /* CONFIG_CARL9170FW_USB_INIT_FIRMWARE */
258 #ifdef CONFIG_CARL9170FW_USB_INIT_FIRMWARE
260 #endif /* CONFIG_CARL9170FW_USB_INIT_FIRMWARE */
264 * The fw structure is always initialized with "0"
265 * during boot(); No need to waste precious bytes here.
267 * fw.usb.interface_setting = 0;
268 * fw.usb.alternate_interface_setting = 0;
269 * fw.usb.device_feature = 0;
272 #ifdef CONFIG_CARL9170FW_WOL
273 fw.usb.device_feature |= USB_DEVICE_REMOTE_WAKEUP;
274 usb_enable_remote_wakeup();
275 #endif /* CONFIG_CARL9170FW_WOL */
278 #define GET_ARRAY(a, o) ((uint32_t *) (((unsigned long) data) + offset))
280 static void usb_ep0rx_data(const void *data, const unsigned int len)
285 BUG_ON(len > AR9170_USB_EP_CTRL_MAX);
286 BUILD_BUG_ON(len > AR9170_USB_EP_CTRL_MAX);
288 for (offset = 0; offset < ((len + 3) & ~3); offset += 4) {
289 value = get(AR9170_USB_REG_EP0_DATA);
290 memcpy(GET_ARRAY(data, offset), &value,
291 min(len - offset, (unsigned int)4));
295 static int usb_ep0tx_data(const void *data, const unsigned int len)
297 unsigned int offset = 0, block, last_block = 0;
300 BUG_ON(len > AR9170_USB_EP_CTRL_MAX);
301 BUILD_BUG_ON(len > AR9170_USB_EP_CTRL_MAX);
303 block = min(len, (unsigned int) 4);
305 while (offset < len) {
307 if (last_block != block || block < 4)
308 setb(AR9170_USB_REG_FIFO_SIZE, (1 << block) - 1);
310 memcpy(&value, GET_ARRAY(data, offset), block);
312 set(AR9170_USB_REG_EP0_DATA, value);
315 last_block = block = min(len - offset, (unsigned int) 4);
318 setb(AR9170_USB_REG_FIFO_SIZE, 0xf);
320 /* this will push the data to the host */
325 #ifdef CONFIG_CARL9170FW_USB_STANDARD_CMDS
326 static int usb_get_status(const struct usb_ctrlrequest *ctrl)
328 __le16 status = cpu_to_le16(fw.usb.device_feature);
330 if ((ctrl->bRequestType & USB_DIR_MASK) != USB_DIR_IN)
333 switch (ctrl->bRequestType & USB_RECIP_MASK) {
334 case USB_RECIP_DEVICE:
335 status &= cpu_to_le16(~USB_DEVICE_SELF_POWERED);
336 status &= cpu_to_le16(~USB_DEVICE_REMOTE_WAKEUP);
339 case USB_RECIP_INTERFACE:
340 /* USB spec: This is reserved for future use. */
341 status = cpu_to_le16(0);
344 case USB_RECIP_ENDPOINT:
345 case USB_RECIP_OTHER:
350 return usb_ep0tx_data((const void *) &status, sizeof(status));
353 static int usb_get_string_desc(const struct usb_ctrlrequest *ctrl)
355 const struct usb_string_descriptor *string_desc = NULL;
357 switch (le16_to_cpu(ctrl->wValue) & 0xff) {
359 string_desc = (const struct usb_string_descriptor *)
360 rom.hw.usb.string0_desc;
364 string_desc = (const struct usb_string_descriptor *)
365 rom.hw.usb.string1_desc;
369 string_desc = (const struct usb_string_descriptor *)
370 rom.hw.usb.string2_desc;
374 string_desc = (const struct usb_string_descriptor *)
375 rom.hw.usb.string3_desc;
383 return usb_ep0tx_data(string_desc, string_desc->bLength);
388 static int usb_get_device_desc(const struct usb_ctrlrequest *ctrl __unused)
390 return usb_ep0tx_data(&rom.hw.usb.device_desc,
391 rom.hw.usb.device_desc.bLength);
394 static int usb_get_config_desc(const struct usb_ctrlrequest *ctrl __unused)
396 fw.usb.cfg_desc->cfg.bDescriptorType = USB_DT_CONFIG;
398 return usb_ep0tx_data(fw.usb.cfg_desc,
399 le16_to_cpu(fw.usb.cfg_desc->cfg.wTotalLength));
402 #ifdef CONFIG_CARL9170FW_USB_MODESWITCH
403 static int usb_get_otherspeed_desc(const struct usb_ctrlrequest *ctrl __unused)
406 fw.usb.os_cfg_desc->cfg.bDescriptorType = USB_DT_OTHER_SPEED_CONFIG;
408 return usb_ep0tx_data(fw.usb.os_cfg_desc,
409 le16_to_cpu(fw.usb.os_cfg_desc->cfg.wTotalLength));
411 #endif /* CONFIG_CARL9170FW_USB_MODESWITCH */
413 static int usb_get_qualifier_desc(const struct usb_ctrlrequest *ctrl __unused)
415 struct usb_qualifier_descriptor qual;
418 * The qualifier descriptor shares some structural details
419 * with the main device descriptor.
422 memcpy(&qual, &rom.hw.usb.device_desc, sizeof(qual));
424 /* (Re)-Initialize fields */
425 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
426 qual.bLength = sizeof(qual);
427 qual.bNumConfigurations = rom.hw.usb.device_desc.bNumConfigurations;
430 return usb_ep0tx_data(&qual, qual.bLength);
433 #define USB_CHECK_REQTYPE(ctrl, recip, dir) \
434 (((ctrl->bRequestType & USB_RECIP_MASK) != recip) || \
435 ((ctrl->bRequestType & USB_DIR_MASK) != dir))
437 static int usb_get_descriptor(const struct usb_ctrlrequest *ctrl)
441 if (USB_CHECK_REQTYPE(ctrl, USB_RECIP_DEVICE, USB_DIR_IN))
444 switch (le16_to_cpu(ctrl->wValue) >> 8) {
446 status = usb_get_device_desc(ctrl);
450 status = usb_get_config_desc(ctrl);
454 status = usb_get_string_desc(ctrl);
457 case USB_DT_INTERFACE:
460 case USB_DT_ENDPOINT:
463 case USB_DT_DEVICE_QUALIFIER:
464 status = usb_get_qualifier_desc(ctrl);
467 #ifdef CONFIG_CARL9170FW_USB_MODESWITCH
468 case USB_DT_OTHER_SPEED_CONFIG:
469 status = usb_get_otherspeed_desc(ctrl);
471 #endif /* CONFIG_CARL9170FW_USB_MODESWITCH */
480 static int usb_get_configuration(const struct usb_ctrlrequest *ctrl)
482 if (USB_CHECK_REQTYPE(ctrl, USB_RECIP_DEVICE, USB_DIR_IN))
485 return usb_ep0tx_data(&fw.usb.config, 1);
488 static int usb_set_configuration(const struct usb_ctrlrequest *ctrl)
492 if (USB_CHECK_REQTYPE(ctrl, USB_RECIP_DEVICE, USB_DIR_OUT))
495 config = le16_to_cpu(ctrl->wValue);
499 andb(AR9170_USB_REG_DEVICE_ADDRESS,
500 (uint8_t) ~(AR9170_USB_DEVICE_ADDRESS_CONFIGURE));
501 #ifdef CONFIG_CARL9170FW_USB_MODESWITCH
503 fw.usb.config = config;
505 if (usb_detect_highspeed()) {
506 /* High Speed Configuration */
507 usb_init_highspeed_fifo_cfg();
509 /* Full Speed Configuration */
510 usb_init_fullspeed_fifo_cfg();
517 /* usb_pta_init() ? */
520 orb(AR9170_USB_REG_DEVICE_ADDRESS,
521 (AR9170_USB_DEVICE_ADDRESS_CONFIGURE));
523 usb_enable_global_int();
530 #endif /* CONFIG_CARL9170FW_USB_MODESWITCH */
533 static int usb_set_address(const struct usb_ctrlrequest *ctrl)
535 unsigned int address;
537 if (USB_CHECK_REQTYPE(ctrl, USB_RECIP_DEVICE, USB_DIR_OUT))
540 address = le16_to_cpu(ctrl->wValue);
543 * The original firmware used 0x100 (which is, of course,
544 * too big to fit into uint8_t).
545 * However based on the available information (hw.h), BIT(7)
546 * is used as some sort of flag and should not be
547 * part of the device address.
549 if (address >= BIT(7))
552 setb(AR9170_USB_REG_DEVICE_ADDRESS, (uint8_t) address);
556 static int usb_get_interface(const struct usb_ctrlrequest *ctrl)
558 if (USB_CHECK_REQTYPE(ctrl, USB_RECIP_INTERFACE, USB_DIR_IN))
561 if (usb_configured() == false)
564 switch (fw.usb.config) {
572 return usb_ep0tx_data(&fw.usb.alternate_interface_setting, 1);
575 static int usb_manipulate_feature(const struct usb_ctrlrequest *ctrl, bool __unused clear)
577 unsigned int feature;
578 if (USB_CHECK_REQTYPE(ctrl, USB_RECIP_DEVICE, USB_DIR_OUT))
581 if (usb_configured() == false)
584 feature = le16_to_cpu(ctrl->wValue);
586 #ifdef CONFIG_CARL9170FW_WOL
587 if (feature & USB_DEVICE_REMOTE_WAKEUP) {
589 usb_disable_remote_wakeup();
591 usb_enable_remote_wakeup();
593 #endif /* CONFIG_CARL9170FW_WOL */
596 fw.usb.device_feature &= ~feature;
598 fw.usb.device_feature |= feature;
603 #ifdef CONFIG_CARL9170FW_USB_MODESWITCH
604 static int usb_set_interface(const struct usb_ctrlrequest *ctrl)
606 unsigned int intf, alt_intf;
607 if (USB_CHECK_REQTYPE(ctrl, USB_RECIP_INTERFACE, USB_DIR_OUT))
610 if (usb_configured() == false)
613 intf = le16_to_cpu(ctrl->wIndex);
614 alt_intf = le16_to_cpu(ctrl->wValue);
618 if (alt_intf != fw.usb.cfg_desc->intf.bAlternateSetting)
621 fw.usb.interface_setting = (uint8_t) intf;
622 fw.usb.alternate_interface_setting = (uint8_t) alt_intf;
623 if (usb_detect_highspeed())
624 usb_init_highspeed_fifo_cfg();
626 usb_init_fullspeed_fifo_cfg();
629 usb_enable_global_int();
637 #endif /* CONFIG_CARL9170FW_USB_MODESWITCH */
638 #endif /* CONFIG_CARL9170FW_USB_STANDARD_CMDS */
640 static int usb_standard_command(const struct usb_ctrlrequest *ctrl __unused)
644 #ifdef CONFIG_CARL9170FW_USB_STANDARD_CMDS
645 switch (ctrl->bRequest) {
646 case USB_REQ_GET_STATUS:
647 status = usb_get_status(ctrl);
650 case USB_REQ_CLEAR_FEATURE:
651 case USB_REQ_SET_FEATURE:
652 usb_manipulate_feature(ctrl, ctrl->bRequest == USB_REQ_CLEAR_FEATURE);
655 case USB_REQ_SET_ADDRESS:
656 status = usb_set_address(ctrl);
659 case USB_REQ_GET_DESCRIPTOR:
660 status = usb_get_descriptor(ctrl);
663 case USB_REQ_SET_DESCRIPTOR:
666 case USB_REQ_GET_CONFIGURATION:
667 status = usb_get_configuration(ctrl);
670 case USB_REQ_SET_CONFIGURATION:
671 status = usb_set_configuration(ctrl);
674 case USB_REQ_GET_INTERFACE:
675 status = usb_get_interface(ctrl);
678 case USB_REQ_SET_INTERFACE:
679 #ifdef CONFIG_CARL9170FW_USB_MODESWITCH
680 status = usb_set_interface(ctrl);
681 #endif /* CONFIG_CARL9170FW_USB_MODESWITCH */
684 case USB_REQ_SYNCH_FRAME:
691 #endif /* CONFIG_CARL9170FW_USB_STANDARD_CMDS */
696 static int usb_class_command(const struct usb_ctrlrequest *ctrl __unused)
701 static int usb_vendor_command(const struct usb_ctrlrequest *ctrl __unused)
704 * Note: Firmware upload/boot is not implemented.
705 * It's impossible to replace the current image
712 #undef USB_CHECK_TYPE
714 void usb_ep0setup(void)
716 struct usb_ctrlrequest ctrl;
718 usb_ep0rx_data(&ctrl, sizeof(ctrl));
720 switch (ctrl.bRequestType & USB_TYPE_MASK) {
721 case USB_TYPE_STANDARD:
722 status = usb_standard_command(&ctrl);
726 status = usb_class_command(&ctrl);
729 case USB_TYPE_VENDOR:
730 status = usb_vendor_command(&ctrl);
739 fw.usb.ep0_action |= CARL9170_EP0_STALL;
740 #ifdef CONFIG_CARL9170FW_USB_STANDARD_CMDS
742 fw.usb.ep0_action |= CARL9170_EP0_TRIGGER;
743 #endif /* CONFIG_CARL9170FW_USB_STANDARD_CMDS */
748 if (BUG_ON(!fw.usb.ep0_txrx_buffer || !fw.usb.ep0_txrx_len))
751 usb_ep0rx_data(fw.usb.ep0_txrx_buffer, fw.usb.ep0_txrx_len);
752 fw.usb.ep0_txrx_pos = fw.usb.ep0_txrx_len;
757 if (BUG_ON(!fw.usb.ep0_txrx_buffer || !fw.usb.ep0_txrx_len))
760 usb_ep0tx_data(fw.usb.ep0_txrx_buffer, fw.usb.ep0_txrx_len);
761 fw.usb.ep0_txrx_pos = fw.usb.ep0_txrx_len;