2 * Copyright © 2012 Keith Packard <keithp@keithp.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; version 2 of the License.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
20 #include "ao_product.h"
25 #define USB_DEBUG_DATA 0
28 #ifndef AO_PA11_PA12_RMP
29 #error "must define AO_PA11_PA12_RMP"
32 #ifndef AO_POWER_MANAGEMENT
33 #define AO_POWER_MANAGEMENT 0
37 #define USE_USB_STDIO 1
41 #define AO_USB_OUT_SLEEP_ADDR (&ao_stdin_ready)
43 #define AO_USB_OUT_SLEEP_ADDR (&ao_usb_out_avail)
47 #define debug(format, args...) printf(format, ## args);
49 #define debug(format, args...)
53 #define debug_data(format, args...) printf(format, ## args);
55 #define debug_data(format, args...)
59 uint8_t dir_type_recip;
66 static uint8_t ao_usb_ep0_state;
68 /* Pending EP0 IN data */
69 static const uint8_t *ao_usb_ep0_in_data; /* Remaining data */
70 static uint8_t ao_usb_ep0_in_len; /* Remaining amount */
72 /* Temp buffer for smaller EP0 in data */
73 static uint8_t ao_usb_ep0_in_buf[2];
75 /* Pending EP0 OUT data */
76 static uint8_t *ao_usb_ep0_out_data;
77 static uint8_t ao_usb_ep0_out_len;
80 * Objects allocated in special USB memory
83 /* Buffer description tables */
84 static union stm_usb_bdt *ao_usb_bdt;
85 /* USB address of end of allocated storage */
86 static uint16_t ao_usb_sram_addr;
88 /* Pointer to ep0 tx/rx buffers in USB memory */
89 static uint16_t *ao_usb_ep0_tx_buffer;
90 static uint16_t *ao_usb_ep0_rx_buffer;
93 /* Pointer to interrupt buffer in USB memory */
94 static uint16_t ao_usb_int_tx_offset;
97 /* Pointer to bulk data tx/rx buffers in USB memory */
99 static uint16_t ao_usb_in_tx_offset;
100 static uint16_t *ao_usb_in_tx_buffer;
102 /* System ram shadow of USB buffer; writing individual bytes is
103 * too much of a pain (sigh) */
104 static uint8_t ao_usb_tx_buffer[AO_USB_IN_SIZE];
105 static uint8_t ao_usb_tx_count;
109 static uint16_t ao_usb_out_rx_offset;
110 static uint16_t *ao_usb_out_rx_buffer;
112 /* System ram shadow of USB buffer; writing individual bytes is
113 * too much of a pain (sigh) */
114 static uint8_t ao_usb_rx_buffer[AO_USB_OUT_SIZE];
115 static uint8_t ao_usb_rx_count, ao_usb_rx_pos;
119 static uint16_t ao_usb_in2_tx_offset;
120 static uint16_t *ao_usb_in2_tx_buffer;
122 /* System ram shadow of USB buffer; writing individual bytes is
123 * too much of a pain (sigh) */
124 static uint8_t ao_usb_tx2_buffer[AO_USB_IN_SIZE];
125 static uint8_t ao_usb_tx2_count;
129 * End point register indices
132 #define AO_USB_CONTROL_EPR 0
133 #define AO_USB_INT_EPR 1
134 #define AO_USB_OUT_EPR 2
135 #define AO_USB_IN_EPR 3
136 #define AO_USB_IN2_EPR 4
138 /* Marks when we don't need to send an IN packet.
139 * This happens only when the last IN packet is not full,
140 * otherwise the host will expect to keep seeing packets.
141 * Send a zero-length packet as required
143 static uint8_t ao_usb_in_flushed;
145 /* Marks when we have delivered an IN packet to the hardware
146 * and it has not been received yet. ao_sleep on this address
147 * to wait for it to be delivered.
149 static uint8_t ao_usb_in_pending;
152 /* Marks when we have delivered an IN packet to the hardware
153 * and it has not been received yet. ao_sleep on this address
154 * to wait for it to be delivered.
156 static uint8_t ao_usb_in2_pending;
157 static uint16_t in2_count;
158 static uint8_t ao_usb_in2_flushed;
161 /* Marks when an OUT packet has been received by the hardware
162 * but not pulled to the shadow buffer.
164 static uint8_t ao_usb_out_avail;
165 uint8_t ao_usb_running;
166 static uint8_t ao_usb_configuration;
168 #define AO_USB_EP0_GOT_SETUP 1
169 #define AO_USB_EP0_GOT_RX_DATA 2
170 #define AO_USB_EP0_GOT_TX_ACK 4
172 static uint8_t ao_usb_ep0_receive;
173 static uint8_t ao_usb_address;
174 static uint8_t ao_usb_address_pending;
176 static inline uint32_t set_toggle(uint32_t current_value,
178 uint32_t desired_value)
180 return (current_value ^ desired_value) & mask;
183 static inline uint16_t *ao_usb_packet_buffer_addr(uint16_t sram_addr)
185 return (uint16_t *) (stm_usb_sram + sram_addr);
188 static inline uint16_t ao_usb_packet_buffer_offset(uint16_t *addr)
190 return (uint16_t) ((uint8_t *) addr - stm_usb_sram);
193 static inline uint32_t ao_usb_epr_stat_rx(uint32_t epr) {
194 return (epr >> STM_USB_EPR_STAT_RX) & STM_USB_EPR_STAT_RX_MASK;
197 static inline uint32_t ao_usb_epr_stat_tx(uint32_t epr) {
198 return (epr >> STM_USB_EPR_STAT_TX) & STM_USB_EPR_STAT_TX_MASK;
201 static inline uint32_t ao_usb_epr_ctr_rx(uint32_t epr) {
202 return (epr >> STM_USB_EPR_CTR_RX) & 1;
205 static inline uint32_t ao_usb_epr_ctr_tx(uint32_t epr) {
206 return (epr >> STM_USB_EPR_CTR_TX) & 1;
209 static inline uint32_t ao_usb_epr_setup(uint32_t epr) {
210 return (epr >> STM_USB_EPR_SETUP) & 1;
213 static inline uint32_t ao_usb_epr_dtog_rx(uint32_t epr) {
214 return (epr >> STM_USB_EPR_DTOG_RX) & 1;
217 static inline uint32_t ao_usb_epr_dtog_tx(uint32_t epr) {
218 return (epr >> STM_USB_EPR_DTOG_TX) & 1;
222 * Set current device address and mark the
223 * interface as active
226 ao_usb_set_address(uint8_t address)
228 debug("ao_usb_set_address %02x\n", address);
229 stm_usb.daddr = (1 << STM_USB_DADDR_EF) | address;
230 ao_usb_address_pending = 0;
234 * Write these values to preserve register contents under HW changes
237 #define STM_USB_EPR_INVARIANT ((1 << STM_USB_EPR_CTR_RX) | \
238 (STM_USB_EPR_DTOG_RX_WRITE_INVARIANT << STM_USB_EPR_DTOG_RX) | \
239 (STM_USB_EPR_STAT_RX_WRITE_INVARIANT << STM_USB_EPR_STAT_RX) | \
240 (1 << STM_USB_EPR_CTR_TX) | \
241 (STM_USB_EPR_DTOG_TX_WRITE_INVARIANT << STM_USB_EPR_DTOG_TX) | \
242 (STM_USB_EPR_STAT_TX_WRITE_INVARIANT << STM_USB_EPR_STAT_TX))
244 #define STM_USB_EPR_INVARIANT_MASK ((1 << STM_USB_EPR_CTR_RX) | \
245 (STM_USB_EPR_DTOG_RX_MASK << STM_USB_EPR_DTOG_RX) | \
246 (STM_USB_EPR_STAT_RX_MASK << STM_USB_EPR_STAT_RX) | \
247 (1 << STM_USB_EPR_CTR_TX) | \
248 (STM_USB_EPR_DTOG_TX_MASK << STM_USB_EPR_DTOG_TX) | \
249 (STM_USB_EPR_STAT_TX_MASK << STM_USB_EPR_STAT_TX))
252 * These bits are purely under sw control, so preserve them in the
253 * register by re-writing what was read
255 #define STM_USB_EPR_PRESERVE_MASK ((STM_USB_EPR_EP_TYPE_MASK << STM_USB_EPR_EP_TYPE) | \
256 (1 << STM_USB_EPR_EP_KIND) | \
257 (STM_USB_EPR_EA_MASK << STM_USB_EPR_EA))
263 #define _tx_dbg0(msg) _dbg(__LINE__,msg,0)
264 #define _tx_dbg1(msg,value) _dbg(__LINE__,msg,value)
266 #define _tx_dbg0(msg)
267 #define _tx_dbg1(msg,value)
271 #define _rx_dbg0(msg) _dbg(__LINE__,msg,0)
272 #define _rx_dbg1(msg,value) _dbg(__LINE__,msg,value)
274 #define _rx_dbg0(msg)
275 #define _rx_dbg1(msg,value)
279 static void _dbg(int line, char *msg, uint32_t value);
283 * Set the state of the specified endpoint register to a new
284 * value. This is tricky because the bits toggle where the new
285 * value is one, and we need to write invariant values in other
286 * spots of the register. This hardware is strange...
289 _ao_usb_set_stat_tx(int ep, uint32_t stat_tx)
291 uint16_t epr_write, epr_old;
293 _tx_dbg1("set_stat_tx top", stat_tx);
294 epr_old = epr_write = stm_usb.epr[ep].r;
295 epr_write &= STM_USB_EPR_PRESERVE_MASK;
296 epr_write |= STM_USB_EPR_INVARIANT;
297 epr_write |= set_toggle(epr_old,
298 STM_USB_EPR_STAT_TX_MASK << STM_USB_EPR_STAT_TX,
299 stat_tx << STM_USB_EPR_STAT_TX);
300 stm_usb.epr[ep].r = epr_write;
301 _tx_dbg1("set_stat_tx bottom", epr_write);
305 ao_usb_set_stat_tx(int ep, uint32_t stat_tx)
307 ao_arch_block_interrupts();
308 _ao_usb_set_stat_tx(ep, stat_tx);
309 ao_arch_release_interrupts();
313 _ao_usb_set_stat_rx(int ep, uint32_t stat_rx) {
314 uint16_t epr_write, epr_old;
316 epr_write = epr_old = stm_usb.epr[ep].r;
317 epr_write &= STM_USB_EPR_PRESERVE_MASK;
318 epr_write |= STM_USB_EPR_INVARIANT;
319 epr_write |= set_toggle(epr_old,
320 STM_USB_EPR_STAT_RX_MASK << STM_USB_EPR_STAT_RX,
321 stat_rx << STM_USB_EPR_STAT_RX);
322 stm_usb.epr[ep].r = epr_write;
326 ao_usb_set_stat_rx(int ep, uint32_t stat_rx) {
327 ao_arch_block_interrupts();
328 _ao_usb_set_stat_rx(ep, stat_rx);
329 ao_arch_release_interrupts();
333 * Set just endpoint 0, for use during startup
337 ao_usb_init_ep(uint8_t ep, uint32_t addr, uint32_t type, uint32_t stat_rx, uint32_t stat_tx)
341 ao_arch_block_interrupts();
342 epr = stm_usb.epr[ep].r;
343 epr = ((0 << STM_USB_EPR_CTR_RX) |
344 (epr & (1 << STM_USB_EPR_DTOG_RX)) |
346 (STM_USB_EPR_STAT_RX_MASK << STM_USB_EPR_STAT_RX),
347 (stat_rx << STM_USB_EPR_STAT_RX)) |
348 (type << STM_USB_EPR_EP_TYPE) |
349 (0 << STM_USB_EPR_EP_KIND) |
350 (0 << STM_USB_EPR_CTR_TX) |
351 (epr & (1 << STM_USB_EPR_DTOG_TX)) |
353 (STM_USB_EPR_STAT_TX_MASK << STM_USB_EPR_STAT_TX),
354 (stat_tx << STM_USB_EPR_STAT_TX)) |
355 (addr << STM_USB_EPR_EA));
356 stm_usb.epr[ep].r = epr;
357 ao_arch_release_interrupts();
358 debug ("writing epr[%d] 0x%04x wrote 0x%04x\n",
359 ep, epr, stm_usb.epr[ep].r);
363 ao_usb_alloc_buffers(void)
365 ao_usb_sram_addr = 0;
367 ao_usb_bdt = (void *) stm_usb_sram;
368 ao_usb_sram_addr += 8 * STM_USB_BDT_SIZE;
370 ao_usb_ep0_tx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
371 ao_usb_sram_addr += AO_USB_CONTROL_SIZE;
373 ao_usb_ep0_rx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
374 ao_usb_sram_addr += AO_USB_CONTROL_SIZE;
378 ao_usb_int_tx_offset = ao_usb_sram_addr;
379 ao_usb_sram_addr += AO_USB_INT_SIZE;
383 ao_usb_out_rx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
384 ao_usb_out_rx_offset = ao_usb_sram_addr;
385 ao_usb_sram_addr += AO_USB_OUT_SIZE;
389 ao_usb_in_tx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
390 ao_usb_in_tx_offset = ao_usb_sram_addr;
391 ao_usb_sram_addr += AO_USB_IN_SIZE;
395 ao_usb_in2_tx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
396 ao_usb_in2_tx_offset = ao_usb_sram_addr;
397 ao_usb_sram_addr += AO_USB_IN_SIZE;
402 ao_usb_init_btable(void)
404 /* Set up EP 0 - a Control end point with 32 bytes of in and out buffers */
406 ao_usb_bdt[0].single.addr_tx = ao_usb_packet_buffer_offset(ao_usb_ep0_tx_buffer);
407 ao_usb_bdt[0].single.count_tx = 0;
409 ao_usb_bdt[0].single.addr_rx = ao_usb_packet_buffer_offset(ao_usb_ep0_rx_buffer);
410 ao_usb_bdt[0].single.count_rx = ((1 << STM_USB_BDT_COUNT_RX_BL_SIZE) |
411 (((AO_USB_CONTROL_SIZE / 32) - 1) << STM_USB_BDT_COUNT_RX_NUM_BLOCK));
419 ao_usb_init_btable();
421 /* buffer table is at the start of USB memory */
424 ao_usb_init_ep(AO_USB_CONTROL_EPR, AO_USB_CONTROL_EP,
425 STM_USB_EPR_EP_TYPE_CONTROL,
426 STM_USB_EPR_STAT_RX_VALID,
427 STM_USB_EPR_STAT_TX_NAK);
429 /* Clear all of the other endpoints */
430 for (e = 1; e < 8; e++) {
432 STM_USB_EPR_EP_TYPE_CONTROL,
433 STM_USB_EPR_STAT_RX_DISABLED,
434 STM_USB_EPR_STAT_TX_DISABLED);
437 ao_usb_set_address(0);
443 ao_usb_set_configuration(void)
445 debug ("ao_usb_set_configuration\n");
448 /* Set up the INT end point */
449 ao_usb_bdt[AO_USB_INT_EPR].single.addr_tx = ao_usb_int_tx_offset;
450 ao_usb_bdt[AO_USB_INT_EPR].single.count_tx = 0;
452 ao_usb_init_ep(AO_USB_INT_EPR,
454 STM_USB_EPR_EP_TYPE_INTERRUPT,
455 STM_USB_EPR_STAT_RX_DISABLED,
456 STM_USB_EPR_STAT_TX_NAK);
460 /* Set up the OUT end point */
461 ao_usb_bdt[AO_USB_OUT_EPR].single.addr_rx = ao_usb_out_rx_offset;
462 ao_usb_bdt[AO_USB_OUT_EPR].single.count_rx = ((1 << STM_USB_BDT_COUNT_RX_BL_SIZE) |
463 (((AO_USB_OUT_SIZE / 32) - 1) << STM_USB_BDT_COUNT_RX_NUM_BLOCK));
465 ao_usb_init_ep(AO_USB_OUT_EPR,
467 STM_USB_EPR_EP_TYPE_BULK,
468 STM_USB_EPR_STAT_RX_VALID,
469 STM_USB_EPR_STAT_TX_DISABLED);
473 /* Set up the IN end point */
474 ao_usb_bdt[AO_USB_IN_EPR].single.addr_tx = ao_usb_in_tx_offset;
475 ao_usb_bdt[AO_USB_IN_EPR].single.count_tx = 0;
477 ao_usb_init_ep(AO_USB_IN_EPR,
479 STM_USB_EPR_EP_TYPE_BULK,
480 STM_USB_EPR_STAT_RX_DISABLED,
481 STM_USB_EPR_STAT_TX_NAK);
485 /* Set up the IN2 end point */
486 ao_usb_bdt[AO_USB_IN2_EPR].single.addr_tx = ao_usb_in2_tx_offset;
487 ao_usb_bdt[AO_USB_IN2_EPR].single.count_tx = 0;
489 ao_usb_init_ep(AO_USB_IN2_EPR,
491 STM_USB_EPR_EP_TYPE_BULK,
492 STM_USB_EPR_STAT_RX_DISABLED,
493 STM_USB_EPR_STAT_TX_NAK);
498 ao_wakeup(&ao_usb_running);
502 static uint16_t control_count;
503 static uint16_t int_count;
504 static uint16_t in_count;
505 static uint16_t out_count;
506 static uint16_t reset_count;
508 /* The USB memory must be accessed in 16-bit units
512 ao_usb_copy_tx(const uint8_t *src, uint16_t *base, uint16_t bytes)
515 *base++ = src[0] | (src[1] << 8);
524 ao_usb_copy_rx(uint8_t *dst, uint16_t *base, uint16_t bytes)
527 uint16_t s = *base++;
537 /* Send an IN data packet */
539 ao_usb_ep0_flush(void)
543 /* Check to see if the endpoint is still busy */
544 if (ao_usb_epr_stat_tx(stm_usb.epr[0].r) == STM_USB_EPR_STAT_TX_VALID) {
545 debug("EP0 not accepting IN data\n");
549 this_len = ao_usb_ep0_in_len;
550 if (this_len > AO_USB_CONTROL_SIZE)
551 this_len = AO_USB_CONTROL_SIZE;
553 if (this_len < AO_USB_CONTROL_SIZE)
554 ao_usb_ep0_state = AO_USB_EP0_IDLE;
556 ao_usb_ep0_in_len -= this_len;
558 debug_data ("Flush EP0 len %d:", this_len);
559 ao_usb_copy_tx(ao_usb_ep0_in_data, ao_usb_ep0_tx_buffer, this_len);
561 ao_usb_ep0_in_data += this_len;
563 /* Mark the endpoint as TX valid to send the packet */
564 ao_usb_bdt[AO_USB_CONTROL_EPR].single.count_tx = this_len;
565 ao_usb_set_stat_tx(AO_USB_CONTROL_EPR, STM_USB_EPR_STAT_TX_VALID);
566 debug ("queue tx. epr 0 now %08x\n", stm_usb.epr[AO_USB_CONTROL_EPR]);
569 /* Read data from the ep0 OUT fifo */
571 ao_usb_ep0_fill(void)
573 uint16_t len = ao_usb_bdt[0].single.count_rx & STM_USB_BDT_COUNT_RX_COUNT_RX_MASK;
575 if (len > ao_usb_ep0_out_len)
576 len = ao_usb_ep0_out_len;
577 ao_usb_ep0_out_len -= len;
579 /* Pull all of the data out of the packet */
580 debug_data ("Fill EP0 len %d:", len);
581 ao_usb_copy_rx(ao_usb_ep0_out_data, ao_usb_ep0_rx_buffer, len);
583 ao_usb_ep0_out_data += len;
586 ao_usb_set_stat_rx(0, STM_USB_EPR_STAT_RX_VALID);
590 ao_usb_ep0_in_reset(void)
592 ao_usb_ep0_in_data = ao_usb_ep0_in_buf;
593 ao_usb_ep0_in_len = 0;
597 ao_usb_ep0_in_queue_byte(uint8_t a)
599 if (ao_usb_ep0_in_len < sizeof (ao_usb_ep0_in_buf))
600 ao_usb_ep0_in_buf[ao_usb_ep0_in_len++] = a;
604 ao_usb_ep0_in_set(const uint8_t *data, uint8_t len)
606 ao_usb_ep0_in_data = data;
607 ao_usb_ep0_in_len = len;
611 ao_usb_ep0_out_set(uint8_t *data, uint8_t len)
613 ao_usb_ep0_out_data = data;
614 ao_usb_ep0_out_len = len;
618 ao_usb_ep0_in_start(uint16_t max)
620 /* Don't send more than asked for */
621 if (ao_usb_ep0_in_len > max)
622 ao_usb_ep0_in_len = max;
626 static struct ao_usb_line_coding ao_usb_line_coding = {115200, 0, 0, 8};
628 #if AO_USB_DEVICE_ID_SERIAL
629 static uint8_t ao_usb_serial[2 + 48];
631 /* Convert a 32-bit value to 8 hexidecimal UCS2 characters */
633 hex_to_ucs2(uint32_t in, uint8_t *out)
637 for (i = 28; i >= 0; i -= 4) {
638 uint8_t bits = (in >> i) & 0xf;
639 *out++ = ((bits < 10) ? '0' : ('a' - 10)) + bits;
644 /* Encode the device ID (96 bits) in hexidecimal to use as a device
648 ao_usb_serial_init(void)
650 ao_usb_serial[0] = 50; /* length */
651 ao_usb_serial[1] = AO_USB_DESC_STRING;
652 hex_to_ucs2(stm_device_id.u_id0, ao_usb_serial + 2 + 0);
653 hex_to_ucs2(stm_device_id.u_id1, ao_usb_serial + 2 + 16);
654 hex_to_ucs2(stm_device_id.u_id2, ao_usb_serial + 2 + 32);
658 /* Walk through the list of descriptors and find a match
661 ao_usb_get_descriptor(uint16_t value)
663 const uint8_t *descriptor;
664 uint8_t type = value >> 8;
665 uint8_t index = value;
667 descriptor = ao_usb_descriptors;
668 while (descriptor[0] != 0) {
669 if (descriptor[1] == type && index-- == 0) {
671 if (type == AO_USB_DESC_CONFIGURATION)
675 #if AO_USB_DEVICE_ID_SERIAL
676 /* Slightly hacky - the serial number is string 3 */
677 if (type == AO_USB_DESC_STRING && (value & 0xff) == 3) {
678 descriptor = ao_usb_serial;
679 len = sizeof (ao_usb_serial);
682 ao_usb_ep0_in_set(descriptor, len);
685 descriptor += descriptor[0];
690 ao_usb_ep0_setup(void)
692 /* Pull the setup packet out of the fifo */
693 ao_usb_ep0_out_set((uint8_t *) &ao_usb_setup, 8);
695 if (ao_usb_ep0_out_len != 0) {
696 debug ("invalid setup packet length\n");
700 if ((ao_usb_setup.dir_type_recip & AO_USB_DIR_IN) || ao_usb_setup.length == 0)
701 ao_usb_ep0_state = AO_USB_EP0_DATA_IN;
703 ao_usb_ep0_state = AO_USB_EP0_DATA_OUT;
705 ao_usb_ep0_in_reset();
707 switch(ao_usb_setup.dir_type_recip & AO_USB_SETUP_TYPE_MASK) {
708 case AO_USB_TYPE_STANDARD:
709 debug ("Standard setup packet\n");
710 switch(ao_usb_setup.dir_type_recip & AO_USB_SETUP_RECIP_MASK) {
711 case AO_USB_RECIP_DEVICE:
712 debug ("Device setup packet\n");
713 switch(ao_usb_setup.request) {
714 case AO_USB_REQ_GET_STATUS:
715 debug ("get status\n");
716 ao_usb_ep0_in_queue_byte(0);
717 ao_usb_ep0_in_queue_byte(0);
719 case AO_USB_REQ_SET_ADDRESS:
720 debug ("set address %d\n", ao_usb_setup.value);
721 ao_usb_address = ao_usb_setup.value;
722 ao_usb_address_pending = 1;
724 case AO_USB_REQ_GET_DESCRIPTOR:
725 debug ("get descriptor %d\n", ao_usb_setup.value);
726 ao_usb_get_descriptor(ao_usb_setup.value);
728 case AO_USB_REQ_GET_CONFIGURATION:
729 debug ("get configuration %d\n", ao_usb_configuration);
730 ao_usb_ep0_in_queue_byte(ao_usb_configuration);
732 case AO_USB_REQ_SET_CONFIGURATION:
733 ao_usb_configuration = ao_usb_setup.value;
734 debug ("set configuration %d\n", ao_usb_configuration);
735 ao_usb_set_configuration();
739 case AO_USB_RECIP_INTERFACE:
740 debug ("Interface setup packet\n");
741 switch(ao_usb_setup.request) {
742 case AO_USB_REQ_GET_STATUS:
743 ao_usb_ep0_in_queue_byte(0);
744 ao_usb_ep0_in_queue_byte(0);
746 case AO_USB_REQ_GET_INTERFACE:
747 ao_usb_ep0_in_queue_byte(0);
749 case AO_USB_REQ_SET_INTERFACE:
753 case AO_USB_RECIP_ENDPOINT:
754 debug ("Endpoint setup packet\n");
755 switch(ao_usb_setup.request) {
756 case AO_USB_REQ_GET_STATUS:
757 ao_usb_ep0_in_queue_byte(0);
758 ao_usb_ep0_in_queue_byte(0);
764 case AO_USB_TYPE_CLASS:
765 debug ("Class setup packet\n");
766 switch (ao_usb_setup.request) {
767 case AO_USB_SET_LINE_CODING:
768 debug ("set line coding\n");
769 ao_usb_ep0_out_set((uint8_t *) &ao_usb_line_coding, 7);
771 case AO_USB_GET_LINE_CODING:
772 debug ("get line coding\n");
773 ao_usb_ep0_in_set((const uint8_t *) &ao_usb_line_coding, 7);
775 case AO_USB_SET_CONTROL_LINE_STATE:
781 /* If we're not waiting to receive data from the host,
782 * queue an IN response
784 if (ao_usb_ep0_state == AO_USB_EP0_DATA_IN)
785 ao_usb_ep0_in_start(ao_usb_setup.length);
789 ao_usb_ep0_handle(uint8_t receive)
791 ao_usb_ep0_receive = 0;
792 if (receive & AO_USB_EP0_GOT_SETUP) {
796 if (receive & AO_USB_EP0_GOT_RX_DATA) {
797 debug ("\tgot rx data\n");
798 if (ao_usb_ep0_state == AO_USB_EP0_DATA_OUT) {
800 if (ao_usb_ep0_out_len == 0) {
801 ao_usb_ep0_state = AO_USB_EP0_DATA_IN;
802 ao_usb_ep0_in_start(0);
806 if (receive & AO_USB_EP0_GOT_TX_ACK) {
807 debug ("\tgot tx ack\n");
809 #if HAS_FLIGHT && AO_USB_FORCE_IDLE
810 ao_flight_force_idle = 1;
812 /* Wait until the IN packet is received from addr 0
813 * before assigning our local address
815 if (ao_usb_address_pending)
816 ao_usb_set_address(ao_usb_address);
817 if (ao_usb_ep0_state == AO_USB_EP0_DATA_IN)
822 #if AO_POWER_MANAGEMENT
826 stm_usb.cntr |= (1 << STM_USB_CNTR_FSUSP);
828 stm_usb.cntr |= (1 << STM_USB_CNTR_LP_MODE);
836 stm_usb.cntr &= ~(1 << STM_USB_CNTR_FSUSP);
844 uint32_t istr = stm_usb.istr;
846 stm_usb.istr = ~istr;
847 if (istr & (1 << STM_USB_ISTR_CTR)) {
848 uint8_t ep = istr & STM_USB_ISTR_EP_ID_MASK;
849 uint16_t epr, epr_write;
851 /* Preserve the SW write bits, don't mess with most HW writable bits,
852 * clear the CTR_RX and CTR_TX bits
854 epr = stm_usb.epr[ep].r;
856 epr_write &= STM_USB_EPR_PRESERVE_MASK;
857 epr_write |= STM_USB_EPR_INVARIANT;
858 epr_write &= ~(1 << STM_USB_EPR_CTR_RX);
859 epr_write &= ~(1 << STM_USB_EPR_CTR_TX);
860 stm_usb.epr[ep].r = epr_write;
865 if (ao_usb_epr_ctr_rx(epr)) {
866 if (ao_usb_epr_setup(epr))
867 ao_usb_ep0_receive |= AO_USB_EP0_GOT_SETUP;
869 ao_usb_ep0_receive |= AO_USB_EP0_GOT_RX_DATA;
871 if (ao_usb_epr_ctr_tx(epr))
872 ao_usb_ep0_receive |= AO_USB_EP0_GOT_TX_ACK;
873 ao_usb_ep0_handle(ao_usb_ep0_receive);
877 if (ao_usb_epr_ctr_rx(epr)) {
878 _rx_dbg1("RX ISR", epr);
879 ao_usb_out_avail = 1;
880 _rx_dbg0("out avail set");
881 ao_wakeup(AO_USB_OUT_SLEEP_ADDR);
882 _rx_dbg0("stdin awoken");
887 _tx_dbg1("TX ISR", epr);
888 if (ao_usb_epr_ctr_tx(epr)) {
889 ao_usb_in_pending = 0;
890 ao_wakeup(&ao_usb_in_pending);
896 _tx_dbg1("TX2 ISR", epr);
897 if (ao_usb_epr_ctr_tx(epr)) {
898 ao_usb_in2_pending = 0;
899 ao_wakeup(&ao_usb_in2_pending);
905 if (ao_usb_epr_ctr_tx(epr))
906 _ao_usb_set_stat_tx(AO_USB_INT_EPR, STM_USB_EPR_STAT_TX_NAK);
912 if (istr & (1 << STM_USB_ISTR_RESET)) {
917 #if AO_POWER_MANAGEMENT
918 if (istr & (1 << STM_USB_ISTR_SUSP)) {
919 debug ("\tsuspend\n");
922 if (istr & (1 << STM_USB_ISTR_WKUP)) {
923 debug ("\twakeup\n");
930 /* Queue the current IN buffer for transmission */
932 _ao_usb_in_send(void)
934 _tx_dbg0("in_send start");
935 debug ("send %d\n", ao_usb_tx_count);
936 while (ao_usb_in_pending)
937 ao_sleep(&ao_usb_in_pending);
938 ao_usb_in_pending = 1;
939 if (ao_usb_tx_count != AO_USB_IN_SIZE)
940 ao_usb_in_flushed = 1;
941 ao_usb_copy_tx(ao_usb_tx_buffer, ao_usb_in_tx_buffer, ao_usb_tx_count);
942 ao_usb_bdt[AO_USB_IN_EPR].single.addr_tx = ao_usb_in_tx_offset;
943 ao_usb_bdt[AO_USB_IN_EPR].single.count_tx = ao_usb_tx_count;
945 _ao_usb_set_stat_tx(AO_USB_IN_EPR, STM_USB_EPR_STAT_TX_VALID);
946 _tx_dbg0("in_send end");
949 /* Wait for a free IN buffer. Interrupts are blocked */
951 _ao_usb_in_wait(void)
954 /* Check if the current buffer is writable */
955 if (ao_usb_tx_count < AO_USB_IN_SIZE)
958 _tx_dbg0("in_wait top");
959 /* Wait for an IN buffer to be ready */
960 while (ao_usb_in_pending)
961 ao_sleep(&ao_usb_in_pending);
962 _tx_dbg0("in_wait bottom");
972 /* Anytime we've sent a character since
973 * the last time we flushed, we'll need
974 * to send a packet -- the only other time
975 * we would send a packet is when that
976 * packet was full, in which case we now
977 * want to send an empty packet
979 ao_arch_block_interrupts();
980 while (!ao_usb_in_flushed) {
981 _tx_dbg0("flush top");
983 _tx_dbg0("flush end");
985 ao_arch_release_interrupts();
989 ao_usb_putchar(char c)
994 ao_arch_block_interrupts();
997 ao_usb_in_flushed = 0;
998 ao_usb_tx_buffer[ao_usb_tx_count++] = (uint8_t) c;
1000 /* Send the packet when full */
1001 if (ao_usb_tx_count == AO_USB_IN_SIZE) {
1002 _tx_dbg0("putchar full");
1004 _tx_dbg0("putchar flushed");
1006 ao_arch_release_interrupts();
1011 /* Queue the current IN buffer for transmission */
1013 _ao_usb_in2_send(void)
1015 _tx_dbg0("in2_send start");
1016 debug ("send2 %d\n", ao_usb_tx_count);
1017 while (ao_usb_in2_pending)
1018 ao_sleep(&ao_usb_in2_pending);
1019 ao_usb_in2_pending = 1;
1020 if (ao_usb_tx2_count != AO_USB_IN_SIZE)
1021 ao_usb_in2_flushed = 1;
1022 ao_usb_copy_tx(ao_usb_tx2_buffer, ao_usb_in2_tx_buffer, ao_usb_tx2_count);
1023 ao_usb_bdt[AO_USB_IN2_EPR].single.addr_tx = ao_usb_in_tx_offset;
1024 ao_usb_bdt[AO_USB_IN2_EPR].single.count_tx = ao_usb_tx_count;
1025 ao_usb_tx2_count = 0;
1026 _ao_usb_set_stat_tx(AO_USB_IN2_EPR, STM_USB_EPR_STAT_TX_VALID);
1027 _tx_dbg0("in2_send end");
1030 /* Wait for a free IN buffer. Interrupts are blocked */
1032 _ao_usb_in2_wait(void)
1035 /* Check if the current buffer is writable */
1036 if (ao_usb_tx2_count < AO_USB_IN_SIZE)
1039 _tx_dbg0("in2_wait top");
1040 /* Wait for an IN buffer to be ready */
1041 while (ao_usb_in2_pending)
1042 ao_sleep(&ao_usb_in2_pending);
1043 _tx_dbg0("in_wait bottom");
1050 if (!ao_usb_running)
1053 /* Anytime we've sent a character since
1054 * the last time we flushed, we'll need
1055 * to send a packet -- the only other time
1056 * we would send a packet is when that
1057 * packet was full, in which case we now
1058 * want to send an empty packet
1060 ao_arch_block_interrupts();
1061 while (!ao_usb_in2_flushed) {
1062 _tx_dbg0("flush2 top");
1064 _tx_dbg0("flush2 end");
1066 ao_arch_release_interrupts();
1070 ao_usb_putchar2(char c)
1072 if (!ao_usb_running)
1075 ao_arch_block_interrupts();
1078 ao_usb_in2_flushed = 0;
1079 ao_usb_tx2_buffer[ao_usb_tx2_count++] = (uint8_t) c;
1081 /* Send the packet when full */
1082 if (ao_usb_tx2_count == AO_USB_IN_SIZE) {
1083 _tx_dbg0("putchar2 full");
1085 _tx_dbg0("putchar2 flushed");
1087 ao_arch_release_interrupts();
1093 _ao_usb_out_recv(void)
1095 _rx_dbg0("out_recv top");
1096 ao_usb_out_avail = 0;
1098 ao_usb_rx_count = ao_usb_bdt[AO_USB_OUT_EPR].single.count_rx & STM_USB_BDT_COUNT_RX_COUNT_RX_MASK;
1100 _rx_dbg1("out_recv count", ao_usb_rx_count);
1101 debug ("recv %d\n", ao_usb_rx_count);
1102 debug_data("Fill OUT len %d:", ao_usb_rx_count);
1103 ao_usb_copy_rx(ao_usb_rx_buffer, ao_usb_out_rx_buffer, ao_usb_rx_count);
1107 /* ACK the packet */
1108 _ao_usb_set_stat_rx(AO_USB_OUT_EPR, STM_USB_EPR_STAT_RX_VALID);
1112 _ao_usb_pollchar(void)
1116 if (!ao_usb_running)
1117 return AO_READ_AGAIN;
1120 if (ao_usb_rx_pos != ao_usb_rx_count)
1123 _rx_dbg0("poll check");
1124 /* Check to see if a packet has arrived */
1125 if (!ao_usb_out_avail) {
1126 _rx_dbg0("poll none");
1127 return AO_READ_AGAIN;
1132 /* Pull a character out of the fifo */
1133 c = ao_usb_rx_buffer[ao_usb_rx_pos++];
1138 ao_usb_getchar(void)
1142 ao_arch_block_interrupts();
1143 while ((c = _ao_usb_pollchar()) == AO_READ_AGAIN)
1144 ao_sleep(AO_USB_OUT_SLEEP_ADDR);
1145 ao_arch_release_interrupts();
1156 buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
1157 ao_usb_sram_addr += AO_USB_IN_SIZE;
1162 ao_usb_free(uint16_t *addr)
1164 uint16_t offset = ao_usb_packet_buffer_offset(addr);
1165 if (offset < ao_usb_sram_addr)
1166 ao_usb_sram_addr = offset;
1170 ao_usb_write(uint16_t *buffer, uint16_t len)
1172 ao_arch_block_interrupts();
1174 /* Wait for everything to be ready at the same time */
1176 /* Make sure USB is connected */
1177 if (!ao_usb_running) {
1178 ao_sleep(&ao_usb_running);
1182 /* Flush any pending regular I/O */
1183 if (ao_usb_tx_count) {
1188 /* Wait for an idle IN buffer */
1189 if (ao_usb_in_pending) {
1190 ao_sleep(&ao_usb_in_pending);
1196 ao_usb_in_pending = 1;
1197 ao_usb_in_flushed = (len != AO_USB_IN_SIZE);
1198 ao_usb_bdt[AO_USB_IN_EPR].single.addr_tx = ao_usb_packet_buffer_offset(buffer);
1199 ao_usb_bdt[AO_USB_IN_EPR].single.count_tx = len;
1200 _ao_usb_set_stat_tx(AO_USB_IN_EPR, STM_USB_EPR_STAT_TX_VALID);
1201 ao_arch_release_interrupts();
1206 ao_usb_write2(uint16_t *buffer, uint16_t len)
1208 ao_arch_block_interrupts();
1210 /* Wait for everything to be ready at the same time */
1212 /* Make sure USB is connected */
1213 if (!ao_usb_running) {
1214 ao_sleep(&ao_usb_running);
1218 /* Flush any pending regular I/O */
1219 if (ao_usb_tx2_count) {
1224 /* Wait for an idle IN buffer */
1225 if (ao_usb_in2_pending) {
1226 ao_sleep(&ao_usb_in2_pending);
1232 ao_usb_in2_pending = 1;
1233 ao_usb_in2_flushed = (len != AO_USB_IN_SIZE);
1234 ao_usb_bdt[AO_USB_IN2_EPR].single.addr_tx = ao_usb_packet_buffer_offset(buffer);
1235 ao_usb_bdt[AO_USB_IN2_EPR].single.count_tx = len;
1236 _ao_usb_set_stat_tx(AO_USB_IN2_EPR, STM_USB_EPR_STAT_TX_VALID);
1237 ao_arch_release_interrupts();
1243 ao_usb_disable(void)
1245 ao_arch_block_interrupts();
1246 stm_usb.cntr = (1 << STM_USB_CNTR_FRES);
1249 /* Disable USB pull-up */
1250 stm_usb.bcdr &= ~(1 << STM_USB_BCDR_DPPU);
1252 /* Switch off the device */
1253 stm_usb.cntr = (1 << STM_USB_CNTR_PDWN) | (1 << STM_USB_CNTR_FRES);
1255 /* Disable the interface */
1256 stm_rcc.apb1enr &= ~(1 << STM_RCC_APB1ENR_USBEN);
1257 ao_arch_release_interrupts();
1265 /* Select HSI48 as USB clock source */
1266 stm_rcc.cfgr3 &= ~(1 << STM_RCC_CFGR3_USBSW);
1268 /* Enable USB device */
1269 stm_rcc.apb1enr |= (1 << STM_RCC_APB1ENR_USBEN);
1271 /* Clear reset condition */
1272 stm_rcc.apb1rstr &= ~(1 << STM_RCC_APB1RSTR_USBRST);
1274 /* Disable USB pull-up */
1275 stm_usb.bcdr &= ~(1 << STM_USB_BCDR_DPPU);
1277 /* Do not touch the GPIOA configuration; USB takes priority
1278 * over GPIO on pins A11 and A12, but if you select alternate
1279 * input 10 (the documented correct selection), then USB is
1280 * pulled low and doesn't work at all
1283 ao_arch_block_interrupts();
1285 /* Route interrupts */
1286 stm_nvic_set_enable(STM_ISR_USB_POS);
1287 stm_nvic_set_priority(STM_ISR_USB_POS, 3);
1289 ao_usb_configuration = 0;
1291 /* Set up buffer descriptors */
1292 ao_usb_init_btable();
1294 /* Reset the USB controller */
1295 stm_usb.cntr = (1 << STM_USB_CNTR_FRES);
1297 /* Clear the reset bit */
1300 /* Clear any spurious interrupts */
1305 debug ("ao_usb_enable\n");
1307 /* Enable interrupts */
1308 stm_usb.cntr = ((1 << STM_USB_CNTR_CTRM) |
1309 (0 << STM_USB_CNTR_PMAOVRM) |
1310 (0 << STM_USB_CNTR_ERRM) |
1311 (AO_POWER_MANAGEMENT << STM_USB_CNTR_WKUPM) |
1312 (AO_POWER_MANAGEMENT << STM_USB_CNTR_SUSPM) |
1313 (1 << STM_USB_CNTR_RESETM) |
1314 (0 << STM_USB_CNTR_SOFM) |
1315 (0 << STM_USB_CNTR_ESOFM) |
1316 (0 << STM_USB_CNTR_RESUME) |
1317 (0 << STM_USB_CNTR_FSUSP) |
1318 (0 << STM_USB_CNTR_LP_MODE) |
1319 (0 << STM_USB_CNTR_PDWN) |
1320 (0 << STM_USB_CNTR_FRES));
1322 ao_arch_release_interrupts();
1324 for (t = 0; t < 1000; t++)
1327 /* Enable USB pull-up */
1328 stm_usb.bcdr |= (1 << STM_USB_BCDR_DPPU);
1332 struct ao_task ao_usb_echo_task;
1340 c = ao_usb_getchar();
1351 printf ("control: %d out: %d in: %d int: %d reset: %d\n",
1352 control_count, out_count, in_count, int_count, reset_count);
1355 __code struct ao_cmds ao_usb_cmds[] = {
1356 { ao_usb_irq, "I\0Show USB interrupt counts" },
1364 /* Turn on syscfg */
1365 stm_rcc.apb2enr |= (1 << STM_RCC_APB2ENR_SYSCFGCOMPEN);
1367 /* Set PA11/PA12 remapping bit */
1368 stm_syscfg.cfgr1 |= (AO_PA11_PA12_RMP << STM_SYSCFG_CFGR1_PA11_PA12_RMP);
1370 #ifndef AO_USB_START_DISABLED
1374 #if AO_USB_DEVICE_ID_SERIAL
1375 ao_usb_serial_init();
1378 debug ("ao_usb_init\n");
1379 ao_usb_ep0_state = AO_USB_EP0_IDLE;
1381 ao_usb_alloc_buffers();
1384 ao_add_task(&ao_usb_echo_task, ao_usb_echo, "usb echo");
1387 ao_cmd_register(&ao_usb_cmds[0]);
1391 ao_add_stdio(_ao_usb_pollchar, ao_usb_putchar, ao_usb_flush);
1396 #if TX_DBG || RX_DBG
1406 uint32_t in_pending;
1408 uint32_t in_flushed;
1418 #define NUM_USB_DBG 128
1420 static struct ao_usb_dbg dbg[128];
1423 static void _dbg(int line, char *msg, uint32_t value)
1426 dbg[dbg_i].line = line;
1427 dbg[dbg_i].msg = msg;
1428 dbg[dbg_i].value = value;
1429 asm("mrs %0,primask" : "=&r" (primask));
1430 dbg[dbg_i].primask = primask;
1432 dbg[dbg_i].in_count = in_count;
1433 dbg[dbg_i].in_epr = stm_usb.epr[AO_USB_IN_EPR];
1434 dbg[dbg_i].in_pending = ao_usb_in_pending;
1435 dbg[dbg_i].tx_count = ao_usb_tx_count;
1436 dbg[dbg_i].in_flushed = ao_usb_in_flushed;
1439 dbg[dbg_i].rx_count = ao_usb_rx_count;
1440 dbg[dbg_i].rx_pos = ao_usb_rx_pos;
1441 dbg[dbg_i].out_avail = ao_usb_out_avail;
1442 dbg[dbg_i].out_epr = stm_usb.epr[AO_USB_OUT_EPR];
1444 if (++dbg_i == NUM_USB_DBG)