git.gag.com Git - fw/altos/blob - src/stm/ao_usb_stm.c

   1 /*
   2  * Copyright © 2012 Keith Packard <keithp@keithp.com>
   3  *
   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; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  17  */
  18
  19 #include "ao.h"
  20 #include "ao_usb.h"
  21 #include "ao_product.h"
  22
  23 #define USB_DEBUG       0
  24 #define USB_DEBUG_DATA  0
  25 #define USB_ECHO        0
  26
  27 #ifndef USE_USB_STDIO
  28 #define USE_USB_STDIO   1
  29 #endif
  30
  31 #if USE_USB_STDIO
  32 #define AO_USB_OUT_SLEEP_ADDR   (&ao_stdin_ready)
  33 #else
  34 #define AO_USB_OUT_SLEEP_ADDR   (&ao_usb_out_avail)
  35 #endif
  36
  37 #if USB_DEBUG
  38 #define debug(format, args...)  printf(format, ## args);
  39 #else
  40 #define debug(format, args...)
  41 #endif
  42
  43 #if USB_DEBUG_DATA
  44 #define debug_data(format, args...)     printf(format, ## args);
  45 #else
  46 #define debug_data(format, args...)
  47 #endif
  48
  49 struct ao_usb_setup {
  50         uint8_t         dir_type_recip;
  51         uint8_t         request;
  52         uint16_t        value;
  53         uint16_t        index;
  54         uint16_t        length;
  55 } ao_usb_setup;
  56
  57 static uint8_t  ao_usb_ep0_state;
  58
  59 /* Pending EP0 IN data */
  60 static const uint8_t    *ao_usb_ep0_in_data;    /* Remaining data */
  61 static uint8_t          ao_usb_ep0_in_len;      /* Remaining amount */
  62
  63 /* Temp buffer for smaller EP0 in data */
  64 static uint8_t  ao_usb_ep0_in_buf[2];
  65
  66 /* Pending EP0 OUT data */
  67 static uint8_t *ao_usb_ep0_out_data;
  68 static uint8_t  ao_usb_ep0_out_len;
  69
  70 /*
  71  * Objects allocated in special USB memory
  72  */
  73
  74 /* Buffer description tables */
  75 static union stm_usb_bdt        *ao_usb_bdt;
  76 /* USB address of end of allocated storage */
  77 static uint16_t ao_usb_sram_addr;
  78
  79 /* Pointer to ep0 tx/rx buffers in USB memory */
  80 static uint32_t *ao_usb_ep0_tx_buffer;
  81 static uint32_t *ao_usb_ep0_rx_buffer;
  82
  83 /* Pointer to bulk data tx/rx buffers in USB memory */
  84 static uint32_t *ao_usb_in_tx_buffer;
  85 static uint32_t *ao_usb_out_rx_buffer;
  86
  87 /* System ram shadow of USB buffer; writing individual bytes is
  88  * too much of a pain (sigh) */
  89 static uint8_t  ao_usb_tx_buffer[AO_USB_IN_SIZE];
  90 static uint8_t  ao_usb_tx_count;
  91
  92 static uint8_t  ao_usb_rx_buffer[AO_USB_OUT_SIZE];
  93 static uint8_t  ao_usb_rx_count, ao_usb_rx_pos;
  94
  95 /*
  96  * End point register indices
  97  */
  98
  99 #define AO_USB_CONTROL_EPR      0
 100 #define AO_USB_INT_EPR          1
 101 #define AO_USB_OUT_EPR          2
 102 #define AO_USB_IN_EPR           3
 103
 104 /* Marks when we don't need to send an IN packet.
 105  * This happens only when the last IN packet is not full,
 106  * otherwise the host will expect to keep seeing packets.
 107  * Send a zero-length packet as required
 108  */
 109 static uint8_t  ao_usb_in_flushed;
 110
 111 /* Marks when we have delivered an IN packet to the hardware
 112  * and it has not been received yet. ao_sleep on this address
 113  * to wait for it to be delivered.
 114  */
 115 static uint8_t  ao_usb_in_pending;
 116
 117 /* Marks when an OUT packet has been received by the hardware
 118  * but not pulled to the shadow buffer.
 119  */
 120 static uint8_t  ao_usb_out_avail;
 121 uint8_t         ao_usb_running;
 122 static uint8_t  ao_usb_configuration;
 123
 124 #define AO_USB_EP0_GOT_RESET    1
 125 #define AO_USB_EP0_GOT_SETUP    2
 126 #define AO_USB_EP0_GOT_RX_DATA  4
 127 #define AO_USB_EP0_GOT_TX_ACK   8
 128
 129 static uint8_t  ao_usb_ep0_receive;
 130 static uint8_t  ao_usb_address;
 131 static uint8_t  ao_usb_address_pending;
 132
 133 static inline uint32_t set_toggle(uint32_t      current_value,
 134                                    uint32_t     mask,
 135                                    uint32_t     desired_value)
 136 {
 137         return (current_value ^ desired_value) & mask;
 138 }
 139
 140 static inline uint32_t *ao_usb_packet_buffer_addr(uint16_t sram_addr)
 141 {
 142         return (uint32_t *) (((void *) ((uint8_t *) stm_usb_sram + 2 * sram_addr)));
 143 }
 144
 145 static inline uint32_t ao_usb_epr_stat_rx(uint32_t epr) {
 146         return (epr >> STM_USB_EPR_STAT_RX) & STM_USB_EPR_STAT_RX_MASK;
 147 }
 148
 149 static inline uint32_t ao_usb_epr_stat_tx(uint32_t epr) {
 150         return (epr >> STM_USB_EPR_STAT_TX) & STM_USB_EPR_STAT_TX_MASK;
 151 }
 152
 153 static inline uint32_t ao_usb_epr_ctr_rx(uint32_t epr) {
 154         return (epr >> STM_USB_EPR_CTR_RX) & 1;
 155 }
 156
 157 static inline uint32_t ao_usb_epr_ctr_tx(uint32_t epr) {
 158         return (epr >> STM_USB_EPR_CTR_TX) & 1;
 159 }
 160
 161 static inline uint32_t ao_usb_epr_setup(uint32_t epr) {
 162         return (epr >> STM_USB_EPR_SETUP) & 1;
 163 }
 164
 165 static inline uint32_t ao_usb_epr_dtog_rx(uint32_t epr) {
 166         return (epr >> STM_USB_EPR_DTOG_RX) & 1;
 167 }
 168
 169 static inline uint32_t ao_usb_epr_dtog_tx(uint32_t epr) {
 170         return (epr >> STM_USB_EPR_DTOG_TX) & 1;
 171 }
 172
 173 /*
 174  * Set current device address and mark the
 175  * interface as active
 176  */
 177 static void
 178 ao_usb_set_address(uint8_t address)
 179 {
 180         debug("ao_usb_set_address %02x\n", address);
 181         stm_usb.daddr = (1 << STM_USB_DADDR_EF) | address;
 182         ao_usb_address_pending = 0;
 183 }
 184
 185 /*
 186  * Write these values to preserve register contents under HW changes
 187  */
 188
 189 #define STM_USB_EPR_INVARIANT   ((1 << STM_USB_EPR_CTR_RX) |            \
 190                                  (STM_USB_EPR_DTOG_RX_WRITE_INVARIANT << STM_USB_EPR_DTOG_RX) | \
 191                                  (STM_USB_EPR_STAT_RX_WRITE_INVARIANT << STM_USB_EPR_STAT_RX) | \
 192                                  (1 << STM_USB_EPR_CTR_TX) |            \
 193                                  (STM_USB_EPR_DTOG_TX_WRITE_INVARIANT << STM_USB_EPR_DTOG_TX) | \
 194                                  (STM_USB_EPR_STAT_TX_WRITE_INVARIANT << STM_USB_EPR_STAT_TX))
 195
 196 #define STM_USB_EPR_INVARIANT_MASK      ((1 << STM_USB_EPR_CTR_RX) |    \
 197                                          (STM_USB_EPR_DTOG_RX_MASK << STM_USB_EPR_DTOG_RX) | \
 198                                          (STM_USB_EPR_STAT_RX_MASK << STM_USB_EPR_STAT_RX) | \
 199                                          (1 << STM_USB_EPR_CTR_TX) |    \
 200                                          (STM_USB_EPR_DTOG_TX_MASK << STM_USB_EPR_DTOG_TX) | \
 201                                          (STM_USB_EPR_STAT_TX_MASK << STM_USB_EPR_STAT_TX))
 202
 203 /*
 204  * These bits are purely under sw control, so preserve them in the
 205  * register by re-writing what was read
 206  */
 207 #define STM_USB_EPR_PRESERVE_MASK       ((STM_USB_EPR_EP_TYPE_MASK << STM_USB_EPR_EP_TYPE) | \
 208                                          (1 << STM_USB_EPR_EP_KIND) |   \
 209                                          (STM_USB_EPR_EA_MASK << STM_USB_EPR_EA))
 210
 211 #define TX_DBG 0
 212 #define RX_DBG 0
 213
 214 #if TX_DBG
 215 #define _tx_dbg0(msg) _dbg(__LINE__,msg,0)
 216 #define _tx_dbg1(msg,value) _dbg(__LINE__,msg,value)
 217 #else
 218 #define _tx_dbg0(msg)
 219 #define _tx_dbg1(msg,value)
 220 #endif
 221
 222 #if RX_DBG
 223 #define _rx_dbg0(msg) _dbg(__LINE__,msg,0)
 224 #define _rx_dbg1(msg,value) _dbg(__LINE__,msg,value)
 225 #else
 226 #define _rx_dbg0(msg)
 227 #define _rx_dbg1(msg,value)
 228 #endif
 229
 230 #if TX_DBG || RX_DBG
 231 static void _dbg(int line, char *msg, uint32_t value);
 232 #endif
 233
 234 /*
 235  * Set the state of the specified endpoint register to a new
 236  * value. This is tricky because the bits toggle where the new
 237  * value is one, and we need to write invariant values in other
 238  * spots of the register. This hardware is strange...
 239  */
 240 static void
 241 _ao_usb_set_stat_tx(int ep, uint32_t stat_tx)
 242 {
 243         uint32_t        epr_write, epr_old;
 244
 245         _tx_dbg1("set_stat_tx top", stat_tx);
 246         epr_old = epr_write = stm_usb.epr[ep];
 247         epr_write &= STM_USB_EPR_PRESERVE_MASK;
 248         epr_write |= STM_USB_EPR_INVARIANT;
 249         epr_write |= set_toggle(epr_old,
 250                               STM_USB_EPR_STAT_TX_MASK << STM_USB_EPR_STAT_TX,
 251                               stat_tx << STM_USB_EPR_STAT_TX);
 252         stm_usb.epr[ep] = epr_write;
 253         _tx_dbg1("set_stat_tx bottom", epr_write);
 254 }
 255
 256 static void
 257 ao_usb_set_stat_tx(int ep, uint32_t stat_tx)
 258 {
 259         ao_arch_block_interrupts();
 260         _ao_usb_set_stat_tx(ep, stat_tx);
 261         ao_arch_release_interrupts();
 262 }
 263
 264 static void
 265 _ao_usb_set_stat_rx(int ep, uint32_t stat_rx) {
 266         uint32_t        epr_write, epr_old;
 267
 268         epr_write = epr_old = stm_usb.epr[ep];
 269         epr_write &= STM_USB_EPR_PRESERVE_MASK;
 270         epr_write |= STM_USB_EPR_INVARIANT;
 271         epr_write |= set_toggle(epr_old,
 272                               STM_USB_EPR_STAT_RX_MASK << STM_USB_EPR_STAT_RX,
 273                               stat_rx << STM_USB_EPR_STAT_RX);
 274         stm_usb.epr[ep] = epr_write;
 275 }
 276
 277 static void
 278 ao_usb_set_stat_rx(int ep, uint32_t stat_rx) {
 279         ao_arch_block_interrupts();
 280         _ao_usb_set_stat_rx(ep, stat_rx);
 281         ao_arch_release_interrupts();
 282 }
 283
 284 /*
 285  * Set just endpoint 0, for use during startup
 286  */
 287
 288 static void
 289 ao_usb_init_ep(uint8_t ep, uint32_t addr, uint32_t type, uint32_t stat_rx, uint32_t stat_tx)
 290 {
 291         uint32_t                epr;
 292         ao_arch_block_interrupts();
 293         epr = stm_usb.epr[ep];
 294         epr = ((0 << STM_USB_EPR_CTR_RX) |
 295                (epr & (1 << STM_USB_EPR_DTOG_RX)) |
 296                set_toggle(epr,
 297                           (STM_USB_EPR_STAT_RX_MASK << STM_USB_EPR_STAT_RX),
 298                           (stat_rx << STM_USB_EPR_STAT_RX)) |
 299                (type << STM_USB_EPR_EP_TYPE) |
 300                (0 << STM_USB_EPR_EP_KIND) |
 301                (0 << STM_USB_EPR_CTR_TX) |
 302                (epr & (1 << STM_USB_EPR_DTOG_TX)) |
 303                set_toggle(epr,
 304                           (STM_USB_EPR_STAT_TX_MASK << STM_USB_EPR_STAT_TX),
 305                           (stat_tx << STM_USB_EPR_STAT_TX)) |
 306                (addr << STM_USB_EPR_EA));
 307         stm_usb.epr[ep] = epr;
 308         ao_arch_release_interrupts();
 309         debug ("writing epr[%d] 0x%08x wrote 0x%08x\n",
 310                ep, epr, stm_usb.epr[ep]);
 311 }
 312
 313 static void
 314 ao_usb_set_ep0(void)
 315 {
 316         uint8_t e;
 317
 318         ao_usb_sram_addr = 0;
 319
 320         /* buffer table is at the start of USB memory */
 321         stm_usb.btable = 0;
 322         ao_usb_bdt = (void *) stm_usb_sram;
 323
 324         ao_usb_sram_addr += 8 * STM_USB_BDT_SIZE;
 325
 326         /* Set up EP 0 - a Control end point with 32 bytes of in and out buffers */
 327
 328         ao_usb_bdt[0].single.addr_tx = ao_usb_sram_addr;
 329         ao_usb_bdt[0].single.count_tx = 0;
 330         ao_usb_ep0_tx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
 331         ao_usb_sram_addr += AO_USB_CONTROL_SIZE;
 332
 333         ao_usb_bdt[0].single.addr_rx = ao_usb_sram_addr;
 334         ao_usb_bdt[0].single.count_rx = ((1 << STM_USB_BDT_COUNT_RX_BL_SIZE) |
 335                                   (((AO_USB_CONTROL_SIZE / 32) - 1) << STM_USB_BDT_COUNT_RX_NUM_BLOCK));
 336         ao_usb_ep0_rx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
 337         ao_usb_sram_addr += AO_USB_CONTROL_SIZE;
 338
 339         ao_usb_init_ep(AO_USB_CONTROL_EPR, AO_USB_CONTROL_EP,
 340                        STM_USB_EPR_EP_TYPE_CONTROL,
 341                        STM_USB_EPR_STAT_RX_VALID,
 342                        STM_USB_EPR_STAT_TX_NAK);
 343
 344         /* Clear all of the other endpoints */
 345         for (e = 1; e < 8; e++) {
 346                 ao_usb_init_ep(e, 0,
 347                                STM_USB_EPR_EP_TYPE_CONTROL,
 348                                STM_USB_EPR_STAT_RX_DISABLED,
 349                                STM_USB_EPR_STAT_TX_DISABLED);
 350         }
 351
 352         ao_usb_set_address(0);
 353
 354         ao_usb_running = 0;
 355
 356         /* Reset our internal state
 357          */
 358
 359         ao_usb_ep0_state = AO_USB_EP0_IDLE;
 360
 361         ao_usb_ep0_in_data = NULL;
 362         ao_usb_ep0_in_len = 0;
 363
 364         ao_usb_ep0_out_data = 0;
 365         ao_usb_ep0_out_len = 0;
 366 }
 367
 368 static void
 369 ao_usb_set_configuration(void)
 370 {
 371         debug ("ao_usb_set_configuration\n");
 372
 373         /* Set up the INT end point */
 374         ao_usb_bdt[AO_USB_INT_EPR].single.addr_tx = ao_usb_sram_addr;
 375         ao_usb_bdt[AO_USB_INT_EPR].single.count_tx = 0;
 376         ao_usb_in_tx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
 377         ao_usb_sram_addr += AO_USB_INT_SIZE;
 378
 379         ao_usb_init_ep(AO_USB_INT_EPR,
 380                        AO_USB_INT_EP,
 381                        STM_USB_EPR_EP_TYPE_INTERRUPT,
 382                        STM_USB_EPR_STAT_RX_DISABLED,
 383                        STM_USB_EPR_STAT_TX_NAK);
 384
 385         /* Set up the OUT end point */
 386         ao_usb_bdt[AO_USB_OUT_EPR].single.addr_rx = ao_usb_sram_addr;
 387         ao_usb_bdt[AO_USB_OUT_EPR].single.count_rx = ((1 << STM_USB_BDT_COUNT_RX_BL_SIZE) |
 388                                                       (((AO_USB_OUT_SIZE / 32) - 1) << STM_USB_BDT_COUNT_RX_NUM_BLOCK));
 389         ao_usb_out_rx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
 390         ao_usb_sram_addr += AO_USB_OUT_SIZE;
 391
 392         ao_usb_init_ep(AO_USB_OUT_EPR,
 393                        AO_USB_OUT_EP,
 394                        STM_USB_EPR_EP_TYPE_BULK,
 395                        STM_USB_EPR_STAT_RX_VALID,
 396                        STM_USB_EPR_STAT_TX_DISABLED);
 397
 398         /* Set up the IN end point */
 399         ao_usb_bdt[AO_USB_IN_EPR].single.addr_tx = ao_usb_sram_addr;
 400         ao_usb_bdt[AO_USB_IN_EPR].single.count_tx = 0;
 401         ao_usb_in_tx_buffer = ao_usb_packet_buffer_addr(ao_usb_sram_addr);
 402         ao_usb_sram_addr += AO_USB_IN_SIZE;
 403
 404         ao_usb_init_ep(AO_USB_IN_EPR,
 405                        AO_USB_IN_EP,
 406                        STM_USB_EPR_EP_TYPE_BULK,
 407                        STM_USB_EPR_STAT_RX_DISABLED,
 408                        STM_USB_EPR_STAT_TX_NAK);
 409
 410         ao_usb_in_flushed = 0;
 411         ao_usb_in_pending = 0;
 412         ao_wakeup(&ao_usb_in_pending);
 413
 414         ao_usb_out_avail = 0;
 415         ao_usb_configuration = 0;
 416
 417         ao_usb_running = 1;
 418         ao_wakeup(&ao_usb_running);
 419 }
 420
 421 static uint16_t control_count;
 422 static uint16_t int_count;
 423 static uint16_t in_count;
 424 static uint16_t out_count;
 425 static uint16_t reset_count;
 426
 427 /* The USB memory holds 16 bit values on 32 bit boundaries
 428  * and must be accessed only in 32 bit units. Sigh.
 429  */
 430
 431 static inline void
 432 ao_usb_write_byte(uint8_t byte, uint32_t *base, uint16_t offset)
 433 {
 434         base += offset >> 1;
 435         if (offset & 1) {
 436                 *base = (*base & 0xff) | ((uint32_t) byte << 8);
 437         } else {
 438                 *base = (*base & 0xff00) | byte;
 439         }
 440 }
 441
 442 static inline void
 443 ao_usb_write_short(uint16_t data, uint32_t *base, uint16_t offset)
 444 {
 445         base[offset>>1] = data;
 446 }
 447
 448 static void
 449 ao_usb_write(const uint8_t *src, uint32_t *base, uint16_t bytes)
 450 {
 451         uint16_t offset = 0;
 452         if (!bytes)
 453                 return;
 454         while (bytes >= 2) {
 455                 debug_data (" %02x %02x", src[0], src[1]);
 456                 ao_usb_write_short((uint16_t) ((uint16_t) (src[1] << 8) | (uint16_t) src[0]), base, offset);
 457                 offset += 2;
 458                 src += 2;
 459                 bytes -= 2;
 460         }
 461         if (bytes) {
 462                 debug_data (" %02x", src[0]);
 463                 ao_usb_write_byte(*src, base, offset);
 464         }
 465 }
 466
 467 static inline uint8_t
 468 ao_usb_read_byte(uint32_t *base, uint16_t offset)
 469 {
 470         base += offset >> 1;
 471         if (offset & 1)
 472                 return (*base >> 8) & 0xff;
 473         else
 474                 return *base & 0xff;
 475 }
 476
 477 static inline uint16_t
 478 ao_usb_read_short(uint32_t *base, uint16_t offset)
 479 {
 480         return (uint16_t) (base[offset>>1]);
 481 }
 482
 483 static void
 484 ao_usb_read(uint8_t *dst, uint32_t *base, uint16_t offset, uint16_t bytes)
 485 {
 486         if (!bytes)
 487                 return;
 488         if (offset & 1) {
 489                 *dst++ = ao_usb_read_byte(base, offset++);
 490                 debug_data (" %02x", dst[-1]);
 491                 bytes--;
 492         }
 493         while (bytes >= 2) {
 494                 uint16_t        s = ao_usb_read_short(base, offset);
 495                 dst[0] = (uint8_t) s;
 496                 dst[1] = (uint8_t) (s >> 8);
 497                 debug_data (" %02x %02x", dst[0], dst[1]);
 498                 offset += 2;
 499                 dst += 2;
 500                 bytes -= 2;
 501         }
 502         if (bytes) {
 503                 *dst = ao_usb_read_byte(base, offset);
 504                 debug_data (" %02x", dst[0]);
 505         }
 506 }
 507
 508 /* Send an IN data packet */
 509 static void
 510 ao_usb_ep0_flush(void)
 511 {
 512         uint8_t this_len;
 513
 514         /* Check to see if the endpoint is still busy */
 515         if (ao_usb_epr_stat_tx(stm_usb.epr[0]) == STM_USB_EPR_STAT_TX_VALID) {
 516                 debug("EP0 not accepting IN data\n");
 517                 return;
 518         }
 519
 520         this_len = ao_usb_ep0_in_len;
 521         if (this_len > AO_USB_CONTROL_SIZE)
 522                 this_len = AO_USB_CONTROL_SIZE;
 523
 524         if (this_len < AO_USB_CONTROL_SIZE)
 525                 ao_usb_ep0_state = AO_USB_EP0_IDLE;
 526
 527         ao_usb_ep0_in_len -= this_len;
 528
 529         debug_data ("Flush EP0 len %d:", this_len);
 530         ao_usb_write(ao_usb_ep0_in_data, ao_usb_ep0_tx_buffer, this_len);
 531         debug_data ("\n");
 532         ao_usb_ep0_in_data += this_len;
 533
 534         /* Mark the endpoint as TX valid to send the packet */
 535         ao_usb_bdt[AO_USB_CONTROL_EPR].single.count_tx = this_len;
 536         ao_usb_set_stat_tx(AO_USB_CONTROL_EPR, STM_USB_EPR_STAT_TX_VALID);
 537         debug ("queue tx. epr 0 now %08x\n", stm_usb.epr[AO_USB_CONTROL_EPR]);
 538 }
 539
 540 /* Read data from the ep0 OUT fifo */
 541 static void
 542 ao_usb_ep0_fill(void)
 543 {
 544         uint16_t        len = ao_usb_bdt[0].single.count_rx & STM_USB_BDT_COUNT_RX_COUNT_RX_MASK;
 545
 546         if (len > ao_usb_ep0_out_len)
 547                 len = ao_usb_ep0_out_len;
 548         ao_usb_ep0_out_len -= (uint8_t) len;
 549
 550         /* Pull all of the data out of the packet */
 551         debug_data ("Fill EP0 len %d:", len);
 552         ao_usb_read(ao_usb_ep0_out_data, ao_usb_ep0_rx_buffer, 0, len);
 553         debug_data ("\n");
 554         ao_usb_ep0_out_data += len;
 555
 556         /* ACK the packet */
 557         ao_usb_set_stat_rx(0, STM_USB_EPR_STAT_RX_VALID);
 558 }
 559
 560 static void
 561 ao_usb_ep0_in_reset(void)
 562 {
 563         ao_usb_ep0_in_data = ao_usb_ep0_in_buf;
 564         ao_usb_ep0_in_len = 0;
 565 }
 566
 567 static void
 568 ao_usb_ep0_in_queue_byte(uint8_t a)
 569 {
 570         if (ao_usb_ep0_in_len < sizeof (ao_usb_ep0_in_buf))
 571                 ao_usb_ep0_in_buf[ao_usb_ep0_in_len++] = a;
 572 }
 573
 574 static void
 575 ao_usb_ep0_in_set(const uint8_t *data, uint8_t len)
 576 {
 577         ao_usb_ep0_in_data = data;
 578         ao_usb_ep0_in_len = len;
 579 }
 580
 581 static void
 582 ao_usb_ep0_out_set(uint8_t *data, uint8_t len)
 583 {
 584         ao_usb_ep0_out_data = data;
 585         ao_usb_ep0_out_len = len;
 586 }
 587
 588 static void
 589 ao_usb_ep0_in_start(uint16_t max)
 590 {
 591         /* Don't send more than asked for */
 592         if (ao_usb_ep0_in_len > max)
 593                 ao_usb_ep0_in_len = (uint8_t) max;
 594         ao_usb_ep0_flush();
 595 }
 596
 597 struct ao_usb_line_coding ao_usb_line_coding = {115200, 0, 0, 8};
 598
 599 /* Walk through the list of descriptors and find a match
 600  */
 601 static void
 602 ao_usb_get_descriptor(uint16_t value, uint16_t length)
 603 {
 604         const uint8_t           *descriptor;
 605         uint8_t         type = (uint8_t) (value >> 8);
 606         uint8_t         index = (uint8_t) value;
 607
 608         descriptor = ao_usb_descriptors;
 609         while (descriptor[0] != 0) {
 610                 if (descriptor[1] == type && index-- == 0) {
 611                         uint8_t len;
 612                         if (type == AO_USB_DESC_CONFIGURATION)
 613                                 len = descriptor[2];
 614                         else
 615                                 len = descriptor[0];
 616                         if (len > length)
 617                                 len = (uint8_t) length;
 618                         ao_usb_ep0_in_set(descriptor, len);
 619                         break;
 620                 }
 621                 descriptor += descriptor[0];
 622         }
 623 }
 624
 625 static void
 626 ao_usb_ep0_setup(void)
 627 {
 628         /* Pull the setup packet out of the fifo */
 629         ao_usb_ep0_out_set((uint8_t *) &ao_usb_setup, 8);
 630         ao_usb_ep0_fill();
 631         if (ao_usb_ep0_out_len != 0) {
 632                 debug ("invalid setup packet length\n");
 633                 return;
 634         }
 635
 636         if ((ao_usb_setup.dir_type_recip & AO_USB_DIR_IN) || ao_usb_setup.length == 0)
 637                 ao_usb_ep0_state = AO_USB_EP0_DATA_IN;
 638         else
 639                 ao_usb_ep0_state = AO_USB_EP0_DATA_OUT;
 640
 641         ao_usb_ep0_in_reset();
 642
 643         switch(ao_usb_setup.dir_type_recip & AO_USB_SETUP_TYPE_MASK) {
 644         case AO_USB_TYPE_STANDARD:
 645                 debug ("Standard setup packet\n");
 646                 switch(ao_usb_setup.dir_type_recip & AO_USB_SETUP_RECIP_MASK) {
 647                 case AO_USB_RECIP_DEVICE:
 648                         debug ("Device setup packet\n");
 649                         switch(ao_usb_setup.request) {
 650                         case AO_USB_REQ_GET_STATUS:
 651                                 debug ("get status\n");
 652                                 ao_usb_ep0_in_queue_byte(0);
 653                                 ao_usb_ep0_in_queue_byte(0);
 654                                 break;
 655                         case AO_USB_REQ_SET_ADDRESS:
 656                                 debug ("set address %d\n", ao_usb_setup.value);
 657                                 ao_usb_address = (uint8_t) ao_usb_setup.value;
 658                                 ao_usb_address_pending = 1;
 659                                 break;
 660                         case AO_USB_REQ_GET_DESCRIPTOR:
 661                                 debug ("get descriptor %d\n", ao_usb_setup.value);
 662                                 ao_usb_get_descriptor(ao_usb_setup.value, ao_usb_setup.length);
 663                                 break;
 664                         case AO_USB_REQ_GET_CONFIGURATION:
 665                                 debug ("get configuration %d\n", ao_usb_configuration);
 666                                 ao_usb_ep0_in_queue_byte(ao_usb_configuration);
 667                                 break;
 668                         case AO_USB_REQ_SET_CONFIGURATION:
 669                                 ao_usb_configuration = (uint8_t) ao_usb_setup.value;
 670                                 debug ("set configuration %d\n", ao_usb_configuration);
 671                                 ao_usb_set_configuration();
 672                                 break;
 673                         }
 674                         break;
 675                 case AO_USB_RECIP_INTERFACE:
 676                         debug ("Interface setup packet\n");
 677                         switch(ao_usb_setup.request) {
 678                         case AO_USB_REQ_GET_STATUS:
 679                                 ao_usb_ep0_in_queue_byte(0);
 680                                 ao_usb_ep0_in_queue_byte(0);
 681                                 break;
 682                         case AO_USB_REQ_GET_INTERFACE:
 683                                 ao_usb_ep0_in_queue_byte(0);
 684                                 break;
 685                         case AO_USB_REQ_SET_INTERFACE:
 686                                 break;
 687                         }
 688                         break;
 689                 case AO_USB_RECIP_ENDPOINT:
 690                         debug ("Endpoint setup packet\n");
 691                         switch(ao_usb_setup.request) {
 692                         case AO_USB_REQ_GET_STATUS:
 693                                 ao_usb_ep0_in_queue_byte(0);
 694                                 ao_usb_ep0_in_queue_byte(0);
 695                                 break;
 696                         }
 697                         break;
 698                 }
 699                 break;
 700         case AO_USB_TYPE_CLASS:
 701                 debug ("Class setup packet\n");
 702                 switch (ao_usb_setup.request) {
 703                 case AO_USB_SET_LINE_CODING:
 704                         debug ("set line coding\n");
 705                         ao_usb_ep0_out_set((uint8_t *) &ao_usb_line_coding, 7);
 706                         break;
 707                 case AO_USB_GET_LINE_CODING:
 708                         debug ("get line coding\n");
 709                         ao_usb_ep0_in_set((const uint8_t *) &ao_usb_line_coding, 7);
 710                         break;
 711                 case AO_USB_SET_CONTROL_LINE_STATE:
 712                         break;
 713                 }
 714                 break;
 715         }
 716
 717         /* If we're not waiting to receive data from the host,
 718          * queue an IN response
 719          */
 720         if (ao_usb_ep0_state == AO_USB_EP0_DATA_IN)
 721                 ao_usb_ep0_in_start(ao_usb_setup.length);
 722 }
 723
 724 static void
 725 ao_usb_ep0_handle(uint8_t receive)
 726 {
 727         ao_usb_ep0_receive = 0;
 728         if (receive & AO_USB_EP0_GOT_RESET) {
 729                 debug ("\treset\n");
 730                 ao_usb_set_ep0();
 731                 return;
 732         }
 733         if (receive & AO_USB_EP0_GOT_SETUP) {
 734                 debug ("\tsetup\n");
 735                 ao_usb_ep0_setup();
 736         }
 737         if (receive & AO_USB_EP0_GOT_RX_DATA) {
 738                 debug ("\tgot rx data\n");
 739                 if (ao_usb_ep0_state == AO_USB_EP0_DATA_OUT) {
 740                         ao_usb_ep0_fill();
 741                         if (ao_usb_ep0_out_len == 0) {
 742                                 ao_usb_ep0_state = AO_USB_EP0_DATA_IN;
 743                                 ao_usb_ep0_in_start(0);
 744                         }
 745                 }
 746         }
 747         if (receive & AO_USB_EP0_GOT_TX_ACK) {
 748                 debug ("\tgot tx ack\n");
 749
 750 #if HAS_FLIGHT && AO_USB_FORCE_IDLE
 751                 ao_flight_force_idle = 1;
 752 #endif
 753                 /* Wait until the IN packet is received from addr 0
 754                  * before assigning our local address
 755                  */
 756                 if (ao_usb_address_pending)
 757                         ao_usb_set_address(ao_usb_address);
 758                 if (ao_usb_ep0_state == AO_USB_EP0_DATA_IN)
 759                         ao_usb_ep0_flush();
 760         }
 761 }
 762
 763 void
 764 stm_usb_lp_isr(void)
 765 {
 766         uint32_t        istr = stm_usb.istr;
 767
 768         if (istr & (1 << STM_USB_ISTR_CTR)) {
 769                 uint8_t         ep = istr & STM_USB_ISTR_EP_ID_MASK;
 770                 uint32_t        epr, epr_write;
 771
 772                 /* Preserve the SW write bits, don't mess with most HW writable bits,
 773                  * clear the CTR_RX and CTR_TX bits
 774                  */
 775                 epr = stm_usb.epr[ep];
 776                 epr_write = epr;
 777                 epr_write &= STM_USB_EPR_PRESERVE_MASK;
 778                 epr_write |= STM_USB_EPR_INVARIANT;
 779                 epr_write &= ~(1UL << STM_USB_EPR_CTR_RX);
 780                 epr_write &= ~(1UL << STM_USB_EPR_CTR_TX);
 781                 stm_usb.epr[ep] = epr_write;
 782
 783                 switch (ep) {
 784                 case 0:
 785                         ++control_count;
 786                         if (ao_usb_epr_ctr_rx(epr)) {
 787                                 if (ao_usb_epr_setup(epr))
 788                                         ao_usb_ep0_receive |= AO_USB_EP0_GOT_SETUP;
 789                                 else
 790                                         ao_usb_ep0_receive |= AO_USB_EP0_GOT_RX_DATA;
 791                         }
 792                         if (ao_usb_epr_ctr_tx(epr))
 793                                 ao_usb_ep0_receive |= AO_USB_EP0_GOT_TX_ACK;
 794                         ao_usb_ep0_handle(ao_usb_ep0_receive);
 795                         break;
 796                 case AO_USB_OUT_EPR:
 797                         ++out_count;
 798                         if (ao_usb_epr_ctr_rx(epr)) {
 799                                 _rx_dbg1("RX ISR", epr);
 800                                 ao_usb_out_avail = 1;
 801                                 _rx_dbg0("out avail set");
 802                                 ao_wakeup(AO_USB_OUT_SLEEP_ADDR);
 803                                 _rx_dbg0("stdin awoken");
 804                         }
 805                         break;
 806                 case AO_USB_IN_EPR:
 807                         ++in_count;
 808                         _tx_dbg1("TX ISR", epr);
 809                         if (ao_usb_epr_ctr_tx(epr)) {
 810                                 ao_usb_in_pending = 0;
 811                                 ao_wakeup(&ao_usb_in_pending);
 812                         }
 813                         break;
 814                 case AO_USB_INT_EPR:
 815                         ++int_count;
 816                         if (ao_usb_epr_ctr_tx(epr))
 817                                 _ao_usb_set_stat_tx(AO_USB_INT_EPR, STM_USB_EPR_STAT_TX_NAK);
 818                         break;
 819                 }
 820                 return;
 821         }
 822
 823         if (istr & (1 << STM_USB_ISTR_RESET)) {
 824                 ++reset_count;
 825                 stm_usb.istr &= ~(1UL << STM_USB_ISTR_RESET);
 826                 ao_usb_ep0_receive |= AO_USB_EP0_GOT_RESET;
 827                 ao_usb_ep0_handle(ao_usb_ep0_receive);
 828         }
 829 }
 830
 831 void
 832 stm_usb_fs_wkup_isr(void)
 833 {
 834         /* USB wakeup, just clear the bit for now */
 835         stm_usb.istr &= ~(1UL << STM_USB_ISTR_WKUP);
 836 }
 837
 838 /* Queue the current IN buffer for transmission */
 839 static void
 840 _ao_usb_in_send(void)
 841 {
 842         _tx_dbg0("in_send start");
 843         debug ("send %d\n", ao_usb_tx_count);
 844         while (ao_usb_in_pending)
 845                 ao_sleep(&ao_usb_in_pending);
 846         ao_usb_in_pending = 1;
 847         if (ao_usb_tx_count != AO_USB_IN_SIZE)
 848                 ao_usb_in_flushed = 1;
 849         ao_usb_write(ao_usb_tx_buffer, ao_usb_in_tx_buffer, ao_usb_tx_count);
 850         ao_usb_bdt[AO_USB_IN_EPR].single.count_tx = ao_usb_tx_count;
 851         ao_usb_tx_count = 0;
 852         _ao_usb_set_stat_tx(AO_USB_IN_EPR, STM_USB_EPR_STAT_TX_VALID);
 853         _tx_dbg0("in_send end");
 854 }
 855
 856 /* Wait for a free IN buffer. Interrupts are blocked */
 857 static void
 858 _ao_usb_in_wait(void)
 859 {
 860         for (;;) {
 861                 /* Check if the current buffer is writable */
 862                 if (ao_usb_tx_count < AO_USB_IN_SIZE)
 863                         break;
 864
 865                 _tx_dbg0("in_wait top");
 866                 /* Wait for an IN buffer to be ready */
 867                 while (ao_usb_in_pending)
 868                         ao_sleep(&ao_usb_in_pending);
 869                 _tx_dbg0("in_wait bottom");
 870         }
 871 }
 872
 873 void
 874 ao_usb_flush(void)
 875 {
 876         if (!ao_usb_running)
 877                 return;
 878
 879         /* Anytime we've sent a character since
 880          * the last time we flushed, we'll need
 881          * to send a packet -- the only other time
 882          * we would send a packet is when that
 883          * packet was full, in which case we now
 884          * want to send an empty packet
 885          */
 886         ao_arch_block_interrupts();
 887         while (!ao_usb_in_flushed) {
 888                 _tx_dbg0("flush top");
 889                 _ao_usb_in_send();
 890                 _tx_dbg0("flush end");
 891         }
 892         ao_arch_release_interrupts();
 893 }
 894
 895 void
 896 ao_usb_putchar(char c)
 897 {
 898         if (!ao_usb_running)
 899                 return;
 900
 901         ao_arch_block_interrupts();
 902         _ao_usb_in_wait();
 903
 904         ao_usb_in_flushed = 0;
 905         ao_usb_tx_buffer[ao_usb_tx_count++] = (uint8_t) c;
 906
 907         /* Send the packet when full */
 908         if (ao_usb_tx_count == AO_USB_IN_SIZE) {
 909                 _tx_dbg0("putchar full");
 910                 _ao_usb_in_send();
 911                 _tx_dbg0("putchar flushed");
 912         }
 913         ao_arch_release_interrupts();
 914 }
 915
 916 static void
 917 _ao_usb_out_recv(void)
 918 {
 919         _rx_dbg0("out_recv top");
 920         ao_usb_out_avail = 0;
 921
 922         ao_usb_rx_count = (uint8_t) (ao_usb_bdt[AO_USB_OUT_EPR].single.count_rx & STM_USB_BDT_COUNT_RX_COUNT_RX_MASK);
 923
 924         _rx_dbg1("out_recv count", ao_usb_rx_count);
 925         debug ("recv %d\n", ao_usb_rx_count);
 926         debug_data("Fill OUT len %d:", ao_usb_rx_count);
 927         ao_usb_read(ao_usb_rx_buffer, ao_usb_out_rx_buffer, 0, ao_usb_rx_count);
 928         debug_data("\n");
 929         ao_usb_rx_pos = 0;
 930
 931         /* ACK the packet */
 932         _ao_usb_set_stat_rx(AO_USB_OUT_EPR, STM_USB_EPR_STAT_RX_VALID);
 933 }
 934
 935 static int
 936 _ao_usb_pollchar(void)
 937 {
 938         uint8_t c;
 939
 940         if (!ao_usb_running)
 941                 return AO_READ_AGAIN;
 942
 943         for (;;) {
 944                 if (ao_usb_rx_pos != ao_usb_rx_count)
 945                         break;
 946
 947                 _rx_dbg0("poll check");
 948                 /* Check to see if a packet has arrived */
 949                 if (!ao_usb_out_avail) {
 950                         _rx_dbg0("poll none");
 951                         return AO_READ_AGAIN;
 952                 }
 953                 _ao_usb_out_recv();
 954         }
 955
 956         /* Pull a character out of the fifo */
 957         c = ao_usb_rx_buffer[ao_usb_rx_pos++];
 958         return c;
 959 }
 960
 961 char
 962 ao_usb_getchar(void)
 963 {
 964         int     c;
 965
 966         ao_arch_block_interrupts();
 967         while ((c = _ao_usb_pollchar()) == AO_READ_AGAIN)
 968                 ao_sleep(AO_USB_OUT_SLEEP_ADDR);
 969         ao_arch_release_interrupts();
 970         return (char) c;
 971 }
 972
 973 #ifndef HAS_USB_DISABLE
 974 #define HAS_USB_DISABLE 1
 975 #endif
 976
 977 #if HAS_USB_DISABLE
 978 void
 979 ao_usb_disable(void)
 980 {
 981         ao_arch_block_interrupts();
 982         stm_usb.cntr = (1 << STM_USB_CNTR_FRES);
 983         stm_usb.istr = 0;
 984
 985         /* Disable USB pull-up */
 986         stm_syscfg.pmc &= ~(1UL << STM_SYSCFG_PMC_USB_PU);
 987
 988         /* Switch off the device */
 989         stm_usb.cntr = (1 << STM_USB_CNTR_PDWN) | (1 << STM_USB_CNTR_FRES);
 990
 991         /* Disable the interface */
 992         stm_rcc.apb1enr &= ~(1UL << STM_RCC_APB1ENR_USBEN);
 993         ao_arch_release_interrupts();
 994 }
 995 #endif
 996
 997 void
 998 ao_usb_enable(void)
 999 {
1000         int     t;
1001
1002         /* Enable SYSCFG */
1003         stm_rcc.apb2enr |= (1 << STM_RCC_APB2ENR_SYSCFGEN);
1004
1005         /* Disable USB pull-up */
1006         stm_syscfg.pmc &= ~(1UL << STM_SYSCFG_PMC_USB_PU);
1007
1008         /* Enable USB device */
1009         stm_rcc.apb1enr |= (1 << STM_RCC_APB1ENR_USBEN);
1010
1011         /* Do not touch the GPIOA configuration; USB takes priority
1012          * over GPIO on pins A11 and A12, but if you select alternate
1013          * input 10 (the documented correct selection), then USB is
1014          * pulled low and doesn't work at all
1015          */
1016
1017         ao_arch_block_interrupts();
1018
1019         /* Route interrupts */
1020         stm_nvic_set_priority(STM_ISR_USB_LP_POS, AO_STM_NVIC_LOW_PRIORITY);
1021         stm_nvic_set_enable(STM_ISR_USB_LP_POS);
1022
1023         ao_usb_configuration = 0;
1024
1025         stm_usb.cntr = (1 << STM_USB_CNTR_FRES);
1026
1027         /* Clear the power down bit */
1028         stm_usb.cntr = 0;
1029
1030         /* Clear any spurious interrupts */
1031         stm_usb.istr = 0;
1032
1033         debug ("ao_usb_enable\n");
1034
1035         /* Enable interrupts */
1036         stm_usb.cntr = ((1 << STM_USB_CNTR_CTRM) |
1037                         (0 << STM_USB_CNTR_PMAOVRM) |
1038                         (0 << STM_USB_CNTR_ERRM) |
1039                         (0 << STM_USB_CNTR_WKUPM) |
1040                         (0 << STM_USB_CNTR_SUSPM) |
1041                         (1 << STM_USB_CNTR_RESETM) |
1042                         (0 << STM_USB_CNTR_SOFM) |
1043                         (0 << STM_USB_CNTR_ESOFM) |
1044                         (0 << STM_USB_CNTR_RESUME) |
1045                         (0 << STM_USB_CNTR_FSUSP) |
1046                         (0 << STM_USB_CNTR_LP_MODE) |
1047                         (0 << STM_USB_CNTR_PDWN) |
1048                         (0 << STM_USB_CNTR_FRES));
1049
1050         ao_arch_release_interrupts();
1051
1052         for (t = 0; t < 1000; t++)
1053                 ao_arch_nop();
1054         /* Enable USB pull-up */
1055         stm_syscfg.pmc |= (1 << STM_SYSCFG_PMC_USB_PU);
1056 }
1057
1058 #if USB_ECHO
1059 struct ao_task ao_usb_echo_task;
1060
1061 static void
1062 ao_usb_echo(void)
1063 {
1064         char    c;
1065
1066         for (;;) {
1067                 c = ao_usb_getchar();
1068                 ao_usb_putchar(c);
1069                 ao_usb_flush();
1070         }
1071 }
1072 #endif
1073
1074 #if USB_DEBUG
1075 static void
1076 ao_usb_irq(void)
1077 {
1078         printf ("control: %d out: %d in: %d int: %d reset: %d\n",
1079                 control_count, out_count, in_count, int_count, reset_count);
1080 }
1081
1082 const struct ao_cmds ao_usb_cmds[] = {
1083         { ao_usb_irq, "I\0Show USB interrupt counts" },
1084         { 0, NULL }
1085 };
1086 #endif
1087
1088 void
1089 ao_usb_init(void)
1090 {
1091         ao_usb_enable();
1092
1093         debug ("ao_usb_init\n");
1094         ao_usb_ep0_state = AO_USB_EP0_IDLE;
1095 #if USB_ECHO
1096         ao_add_task(&ao_usb_echo_task, ao_usb_echo, "usb echo");
1097 #endif
1098 #if USB_DEBUG
1099         ao_cmd_register(&ao_usb_cmds[0]);
1100 #endif
1101 #if !USB_ECHO
1102 #if USE_USB_STDIO
1103         ao_add_stdio(_ao_usb_pollchar, ao_usb_putchar, ao_usb_flush);
1104 #endif
1105 #endif
1106 }
1107
1108 #if TX_DBG || RX_DBG
1109
1110 struct ao_usb_dbg {
1111         int             line;
1112         char            *msg;
1113         uint32_t        value;
1114         uint32_t        prival;
1115 #if TX_DBG
1116         uint16_t        in_count;
1117         uint32_t        in_epr;
1118         uint32_t        in_pending;
1119         uint32_t        tx_count;
1120         uint32_t        in_flushed;
1121 #endif
1122 #if RX_DBG
1123         uint8_t         rx_count;
1124         uint8_t         rx_pos;
1125         uint8_t         out_avail;
1126         uint32_t        out_epr;
1127 #endif
1128 };
1129
1130 #define NUM_USB_DBG     16
1131
1132 static struct ao_usb_dbg dbg[NUM_USB_DBG];
1133 static int dbg_i;
1134
1135 static void _dbg(int line, char *msg, uint32_t value)
1136 {
1137         uint32_t        prival;
1138         dbg[dbg_i].line = line;
1139         dbg[dbg_i].msg = msg;
1140         dbg[dbg_i].value = value;
1141 #if AO_NONMASK_INTERRUPT
1142         asm("mrs %0,basepri" : "=&r" (prival));
1143 #else
1144         asm("mrs %0,primask" : "=&r" (prival));
1145 #endif
1146         dbg[dbg_i].prival = prival;
1147 #if TX_DBG
1148         dbg[dbg_i].in_count = in_count;
1149         dbg[dbg_i].in_epr = stm_usb.epr[AO_USB_IN_EPR];
1150         dbg[dbg_i].in_pending = ao_usb_in_pending;
1151         dbg[dbg_i].tx_count = ao_usb_tx_count;
1152         dbg[dbg_i].in_flushed = ao_usb_in_flushed;
1153 #endif
1154 #if RX_DBG
1155         dbg[dbg_i].rx_count = ao_usb_rx_count;
1156         dbg[dbg_i].rx_pos = ao_usb_rx_pos;
1157         dbg[dbg_i].out_avail = ao_usb_out_avail;
1158         dbg[dbg_i].out_epr = stm_usb.epr[AO_USB_OUT_EPR];
1159 #endif
1160         if (++dbg_i == NUM_USB_DBG)
1161                 dbg_i = 0;
1162 }
1163 #endif