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_XFER_MAX_SIZE       64
  54
  55 /* USB packet memory organization */
  56 #define USB_PACKET_MEMORY_BASE          0x40006000
  57 #define USB_PACKET_MEMORY_SIZE          512
  58
  59 /* Offset of the buffer descriptor table inside the packet memory */
  60 #define USB_BDT_OFFSET \
  61         ((USB_PACKET_MEMORY_SIZE - (sizeof(stm32_UsbBd) * ENP_MAX_NUMB)) & ~7)
  62
  63 #define USB_MEM_ADDR(offset) \
  64         (USB_PACKET_MEMORY_BASE + ((offset << 1) & ~3) + (offset & 1))
  65
  66 #define EP_DTB_READ(slot, offset) \
  67         (*((uint16_t *)(USB_MEM_ADDR((USB_BDT_OFFSET + \
  68                                         (slot) * sizeof(stm32_UsbBd) + \
  69                                         (offset))))))
  70
  71 #define EP_DTB_WRITE(slot, offset, data)  (EP_DTB_READ(slot, offset) = data)
  72
  73 #define ADDR_TX_OFFSET  offsetof(stm32_UsbBd, AddrTx)
  74 #define COUNT_TX_OFFSET offsetof(stm32_UsbBd, CountTx)
  75 #define ADDR_RX_OFFSET  offsetof(stm32_UsbBd, AddrRx)
  76 #define COUNT_RX_OFFSET offsetof(stm32_UsbBd, CountRx)
  77
  78 #define USB_CTRL_RW_MASK          0x070F
  79 #define USB_CTRL_CLEAR_ONLY_MASK  0x8080
  80 #define USB_CTRL_TOGGLE_MASK      0x7070
  81
  82 /* CNTR register flags */
  83 #define bmCTRM                      0x8000
  84 #define bmPMAOVRM                   0x4000
  85 #define bmERRM                      0x2000
  86 #define bmWKUPM                     0x1000
  87 #define bmSUSPM                     0x0800
  88 #define bmRESETM                    0x0400
  89 #define bmSOFM                      0x0200
  90 #define bmESOFM                     0x0100
  91
  92 #define bmRESUME                    0x0010
  93 #define bmFSUSP                     0x0008
  94 #define bmLPMODE                    0x0004
  95 #define bmPDWN                      0x0002
  96 #define bmFRES                      0x0001
  97
  98 /* USB error codes */
  99 enum stm32_usb_error
 100 {
 101         USB_OK = 0,
 102         USB_INTR_ERROR,
 103         USB_INVAL_ERROR,
 104         USB_NODEV_ERROR,
 105         USB_MEMORY_FULL,
 106         USB_BUF_OVERFLOW,
 107         USB_EP_STALLED,
 108         USB_FATAL_ERROR,
 109 };
 110
 111 /* STM32 USB endpoint types */
 112 enum stm32_UsbEpype
 113 {
 114         EP_BULK = 0,
 115         EP_CTRL,
 116         EP_ISO,
 117         EP_INTERRUPT,
 118
 119         EP_TYPE_MAX
 120 };
 121
 122 /* STM32 USB interrupt status register bits */
 123 typedef union
 124 {
 125         uint32_t status;
 126         struct {
 127                 uint8_t EP_ID  : 4;
 128                 uint8_t DIR    : 1;
 129                 uint8_t        : 2;
 130                 uint8_t SZDPR  : 1;
 131                 uint8_t ESOF   : 1;
 132                 uint8_t SOF    : 1;
 133                 uint8_t RESET  : 1;
 134                 uint8_t SUSP   : 1;
 135                 uint8_t WKUP   : 1;
 136                 uint8_t ERR    : 1;
 137                 uint8_t PMAOVR : 1;
 138                 uint8_t CTR    : 1;
 139         };
 140 } PACKED stm32_usb_irq_status_t;
 141
 142 /* Endpoint state */
 143 typedef enum
 144 {
 145         EP_DISABLED = 0,
 146         EP_STALL,
 147         EP_NAK,
 148         EP_VALID
 149 } stm32_UsbEpState;
 150
 151 /* STM32 USB supported endpoints */
 152 typedef enum stm32_UsbEP
 153 {
 154         CTRL_ENP_OUT = 0, CTRL_ENP_IN,
 155         ENP1_OUT, ENP1_IN,
 156         ENP2_OUT, ENP2_IN,
 157         ENP3_OUT, ENP3_IN,
 158         ENP4_OUT, ENP4_IN,
 159         ENP5_OUT, ENP5_IN,
 160         ENP6_OUT, ENP6_IN,
 161         ENP7_OUT, ENP7_IN,
 162         ENP8_OUT, ENP8_IN,
 163         ENP9_OUT, ENP9_IN,
 164         ENP10_OUT, ENP10_IN,
 165         ENP11_OUT, ENP11_IN,
 166         ENP12_OUT, ENP12_IN,
 167         ENP13_OUT, ENP13_IN,
 168         ENP14_OUT, ENP14_IN,
 169         ENP15_OUT, ENP15_IN,
 170
 171         ENP_MAX_NUMB
 172 } stm32_UsbEP;
 173
 174 /* STM32 USB packet memory slot */
 175 typedef struct stm32_UsbMemSlot
 176 {
 177         stm32_UsbEP ep_addr;
 178         uint16_t Start;
 179         uint16_t Size;
 180         struct stm32_UsbMemSlot *next;
 181 } stm32_UsbMemSlot;
 182
 183 /* STM32 USB buffer descriptor (packet memory) */
 184 typedef struct stm32_UsbBd
 185 {
 186         uint16_t AddrTx;
 187         uint16_t CountTx;
 188         uint16_t AddrRx;
 189         uint16_t CountRx;
 190 } PACKED stm32_UsbBd;
 191
 192 /* STM32 USB endpoint I/O status */
 193 typedef enum stm32_UsbIoStatus
 194 {
 195         NOT_READY = 0,
 196         NO_SERVICED,
 197         BEGIN_SERVICED,
 198         COMPLETE,
 199         BUFFER_UNDERRUN,
 200         BUFFER_OVERRUN,
 201         SETUP_OVERWRITE,
 202         STALLED,
 203 } stm32_UsbIoStatus;
 204
 205 /* STM32 USB hardware endpoint descriptor */
 206 typedef struct stm32_UsbEp
 207 {
 208         reg32_t *hw;
 209         uint8_t type;
 210         void (*complete)(int);
 211         ssize_t max_size;
 212         ssize_t offset;
 213         ssize_t size;
 214         stm32_UsbIoStatus status;
 215         union
 216         {
 217                 uint8_t *read_buffer;
 218                 const uint8_t *write_buffer;
 219         };
 220         int32_t avail_data;
 221         uint8_t flags;
 222 } stm32_UsbEp;
 223
 224 /* STM32 USB hardware endpoint flags */
 225 #define STM32_USB_EP_AVAIL_DATA         BV(0)
 226 #define STM32_USB_EP_ZERO_PACKET        BV(1)
 227 #define STM32_USB_EP_ZERO_POSSIBLE      BV(2)
 228
 229 #endif /* USB_STM32_H */