bertos/cpu/cortex-m3/drv/usb_stm32.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \author Andrea Righi <arighi@develer.com>
  34  *
  35  * \brief STM32: USB full-speed device driver
  36  *
  37  * Low-level USB device driver for the STM32 architecture.
  38  */
  39
  40 #ifndef USB_STM32_H
  41 #define USB_STM32_H
  42
  43 #include <cfg/compiler.h>
  44 #include <drv/usb.h>
  45
  46 #define USB_BASE_ADDR                   0x40005C00
  47
  48 #define USB_DM_PIN      (1 << 11)
  49 #define USB_DP_PIN      (1 << 12)
  50 #define USB_DISC_PIN    (1 << 11)
  51
  52 #define USB_EP0_MAX_SIZE        8
  53 #define USB_RX_MAX_SIZE         64
  54 #define USB_TX_MAX_SIZE         64
  55
  56 /* USB packet memory organization */
  57 #define USB_PACKET_MEMORY_BASE          0x40006000
  58 #define USB_PACKET_MEMORY_SIZE          512
  59
  60 /* Offset of the buffer descriptor table inside the packet memory */
  61 #define USB_BDT_OFFSET \
  62         ((USB_PACKET_MEMORY_SIZE - (sizeof(stm32_UsbBd) * ENP_MAX_NUMB)) & ~7)
  63
  64 #define USB_MEM_ADDR(offset) \
  65         (USB_PACKET_MEMORY_BASE + ((offset << 1) & ~3) + (offset & 1))
  66
  67 #define EP_DTB_READ(slot, offset) \
  68         (*((uint16_t *)(USB_MEM_ADDR((USB_BDT_OFFSET + \
  69                                         (slot) * sizeof(stm32_UsbBd) + \
  70                                         (offset))))))
  71
  72 #define EP_DTB_WRITE(slot, offset, data)  (EP_DTB_READ(slot, offset) = data)
  73
  74 #define ADDR_TX_OFFSET  offsetof(stm32_UsbBd, AddrTx)
  75 #define COUNT_TX_OFFSET offsetof(stm32_UsbBd, CountTx)
  76 #define ADDR_RX_OFFSET  offsetof(stm32_UsbBd, AddrRx)
  77 #define COUNT_RX_OFFSET offsetof(stm32_UsbBd, CountRx)
  78
  79 #define USB_CTRL_RW_MASK          0x070F
  80 #define USB_CTRL_CLEAR_ONLY_MASK  0x8080
  81 #define USB_CTRL_TOGGLE_MASK      0x7070
  82
  83 /* CNTR register flags */
  84 #define bmCTRM                      0x8000
  85 #define bmPMAOVRM                   0x4000
  86 #define bmERRM                      0x2000
  87 #define bmWKUPM                     0x1000
  88 #define bmSUSPM                     0x0800
  89 #define bmRESETM                    0x0400
  90 #define bmSOFM                      0x0200
  91 #define bmESOFM                     0x0100
  92
  93 #define bmRESUME                    0x0010
  94 #define bmFSUSP                     0x0008
  95 #define bmLPMODE                    0x0004
  96 #define bmPDWN                      0x0002
  97 #define bmFRES                      0x0001
  98
  99 /* USB error codes */
 100 enum stm32_usb_error
 101 {
 102         USB_OK = 0,
 103         USB_INTR_ERROR,
 104         USB_INVAL_ERROR,
 105         USB_NODEV_ERROR,
 106         USB_MEMORY_FULL,
 107         USB_BUF_OVERFLOW,
 108         USB_EP_STALLED,
 109         USB_FATAL_ERROR,
 110 };
 111
 112 /* STM32 USB endpoint types */
 113 enum stm32_UsbEpype
 114 {
 115         EP_BULK = 0,
 116         EP_CTRL,
 117         EP_ISO,
 118         EP_INTERRUPT,
 119
 120         EP_TYPE_MAX
 121 };
 122
 123 /* STM32 USB interrupt status register bits */
 124 typedef union
 125 {
 126         uint32_t status;
 127         struct {
 128                 uint8_t EP_ID  : 4;
 129                 uint8_t DIR    : 1;
 130                 uint8_t        : 2;
 131                 uint8_t SZDPR  : 1;
 132                 uint8_t ESOF   : 1;
 133                 uint8_t SOF    : 1;
 134                 uint8_t RESET  : 1;
 135                 uint8_t SUSP   : 1;
 136                 uint8_t WKUP   : 1;
 137                 uint8_t ERR    : 1;
 138                 uint8_t PMAOVR : 1;
 139                 uint8_t CTR    : 1;
 140         };
 141 } PACKED stm32_usb_irq_status_t;
 142
 143 /* Endpoint state */
 144 typedef enum
 145 {
 146         EP_DISABLED = 0,
 147         EP_STALL,
 148         EP_NAK,
 149         EP_VALID
 150 } stm32_UsbEpState;
 151
 152 /* STM32 USB supported endpoints */
 153 typedef enum stm32_UsbEP
 154 {
 155         CTRL_ENP_OUT = 0, CTRL_ENP_IN,
 156         ENP1_OUT, ENP1_IN,
 157         ENP2_OUT, ENP2_IN,
 158         ENP3_OUT, ENP3_IN,
 159         ENP4_OUT, ENP4_IN,
 160         ENP5_OUT, ENP5_IN,
 161         ENP6_OUT, ENP6_IN,
 162         ENP7_OUT, ENP7_IN,
 163         ENP8_OUT, ENP8_IN,
 164         ENP9_OUT, ENP9_IN,
 165         ENP10_OUT, ENP10_IN,
 166         ENP11_OUT, ENP11_IN,
 167         ENP12_OUT, ENP12_IN,
 168         ENP13_OUT, ENP13_IN,
 169         ENP14_OUT, ENP14_IN,
 170         ENP15_OUT, ENP15_IN,
 171
 172         ENP_MAX_NUMB
 173 } stm32_UsbEP;
 174
 175 /* STM32 USB packet memory slot */
 176 typedef struct stm32_UsbMemSlot
 177 {
 178         stm32_UsbEP ep_addr;
 179         uint16_t Start;
 180         uint16_t Size;
 181         struct stm32_UsbMemSlot *next;
 182 } stm32_UsbMemSlot;
 183
 184 /* STM32 USB buffer descriptor (packet memory) */
 185 typedef struct stm32_UsbBd
 186 {
 187         uint16_t AddrTx;
 188         uint16_t CountTx;
 189         uint16_t AddrRx;
 190         uint16_t CountRx;
 191 } PACKED stm32_UsbBd;
 192
 193 /* STM32 USB endpoint I/O status */
 194 typedef enum stm32_UsbIoStatus
 195 {
 196         NOT_READY = 0,
 197         NO_SERVICED,
 198         BEGIN_SERVICED,
 199         COMPLETE,
 200         BUFFER_UNDERRUN,
 201         BUFFER_OVERRUN,
 202         SETUP_OVERWRITE,
 203         STALLED,
 204 } stm32_UsbIoStatus;
 205
 206 /* STM32 USB hardware endpoint descriptor */
 207 typedef struct stm32_UsbEp
 208 {
 209         reg32_t *hw;
 210         uint8_t type;
 211         void (*complete)(int);
 212         ssize_t max_size;
 213         ssize_t offset;
 214         ssize_t size;
 215         stm32_UsbIoStatus status;
 216         union
 217         {
 218                 uint8_t *read_buffer;
 219                 const uint8_t *write_buffer;
 220         };
 221         int32_t avail_data;
 222         uint8_t flags;
 223 } stm32_UsbEp;
 224
 225 /* STM32 USB hardware endpoint flags */
 226 #define STM32_USB_EP_AVAIL_DATA         BV(0)
 227 #define STM32_USB_EP_ZERO_PACKET        BV(1)
 228 #define STM32_USB_EP_ZERO_POSSIBLE      BV(2)
 229
 230 #endif /* USB_STM32_H */