flight/pios/stm32f10x/pios_usb.c

   1 /**
   2  ******************************************************************************
   3  * @addtogroup PIOS PIOS Core hardware abstraction layer
   4  * @{
   5  * @addtogroup   PIOS_USB USB Setup Functions
   6  * @brief PIOS USB device implementation
   7  * @{
   8  *
   9  * @file       pios_usb.c
  10  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  11  * @brief      USB device functions (STM32 dependent code)
  12  * @see        The GNU Public License (GPL) Version 3
  13  *
  14  *****************************************************************************/
  15 /*
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful, but
  22  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  23  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  24  * for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License along
  27  * with this program; if not, write to the Free Software Foundation, Inc.,
  28  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  29  */
  30
  31 #include "pios.h"
  32
  33 #ifdef PIOS_INCLUDE_USB
  34
  35 #include "usb_lib.h"
  36 #include "pios_usb_board_data.h"
  37 #include "stm32f10x.h"
  38
  39 #include "pios_usb_priv.h"
  40
  41 #ifdef PIOS_INCLUDE_USB_HID
  42
  43 /* Rx/Tx status */
  44 static bool transfer_possible = false;
  45
  46 enum pios_usb_dev_magic {
  47     PIOS_USB_DEV_MAGIC = 0x17365904,
  48 };
  49
  50 struct pios_usb_dev {
  51     enum pios_usb_dev_magic   magic;
  52     const struct pios_usb_cfg *cfg;
  53 };
  54
  55 /**
  56  * @brief Validate the usb device structure
  57  * @returns 0 if valid device or -1 otherwise
  58  */
  59 static int32_t PIOS_USB_validate(struct pios_usb_dev *usb_dev)
  60 {
  61     if (usb_dev == NULL) {
  62         return -1;
  63     }
  64
  65     if (usb_dev->magic != PIOS_USB_DEV_MAGIC) {
  66         return -1;
  67     }
  68
  69     return 0;
  70 }
  71
  72 #ifdef PIOS_INCLUDE_FREERTOS
  73 static struct pios_usb_dev *PIOS_USB_alloc(void)
  74 {
  75     struct pios_usb_dev *usb_dev;
  76
  77     usb_dev = (struct pios_usb_dev *)pios_malloc(sizeof(*usb_dev));
  78     if (!usb_dev) {
  79         return NULL;
  80     }
  81
  82     usb_dev->magic = PIOS_USB_DEV_MAGIC;
  83     return usb_dev;
  84 }
  85 #else
  86 static struct pios_usb_dev pios_usb_devs[PIOS_USB_MAX_DEVS];
  87 static uint8_t pios_usb_num_devs;
  88 static struct pios_usb_dev *PIOS_USB_alloc(void)
  89 {
  90     struct pios_usb_dev *usb_dev;
  91
  92     if (pios_usb_num_devs >= PIOS_USB_MAX_DEVS) {
  93         return NULL;
  94     }
  95
  96     usb_dev = &pios_usb_devs[pios_usb_num_devs++];
  97     usb_dev->magic = PIOS_USB_DEV_MAGIC;
  98
  99     return usb_dev;
 100 }
 101 #endif /* ifdef PIOS_INCLUDE_FREERTOS */
 102
 103
 104 /**
 105  * Initialises USB COM layer
 106  * \return < 0 if initialisation failed
 107  * \note Applications shouldn't call this function directly, instead please use \ref PIOS_COM layer functions
 108  */
 109 static uint32_t pios_usb_com_id;
 110 int32_t PIOS_USB_Init(uint32_t *usb_id, const struct pios_usb_cfg *cfg)
 111 {
 112     PIOS_Assert(usb_id);
 113     PIOS_Assert(cfg);
 114
 115     struct pios_usb_dev *usb_dev;
 116
 117     usb_dev = (struct pios_usb_dev *)PIOS_USB_alloc();
 118     if (!usb_dev) {
 119         goto out_fail;
 120     }
 121
 122     /* Bind the configuration to the device instance */
 123     usb_dev->cfg = cfg;
 124
 125     PIOS_USB_Reenumerate();
 126
 127     /*
 128      * This is a horrible hack to make this available to
 129      * the interrupt callbacks.  This should go away ASAP.
 130      */
 131     pios_usb_com_id = (uint32_t)usb_dev;
 132
 133     /* Enable the USB Interrupts */
 134     NVIC_Init(&usb_dev->cfg->irq.init);
 135
 136     /* Select USBCLK source */
 137     RCC_USBCLKConfig(RCC_USBCLKSource_PLLCLK_1Div5);
 138     /* Enable the USB clock */
 139     RCC_APB1PeriphClockCmd(RCC_APB1Periph_USB, ENABLE);
 140
 141     USB_Init();
 142     USB_SIL_Init();
 143
 144     *usb_id = (uint32_t)usb_dev;
 145
 146     return 0; /* No error */
 147
 148 out_fail:
 149     return -1;
 150 }
 151
 152 /**
 153  * This function is called by the USB driver on cable connection/disconnection
 154  * \param[in] connected connection status (1 if connected)
 155  * \return < 0 on errors
 156  * \note Applications shouldn't call this function directly, instead please use \ref PIOS_COM layer functions
 157  */
 158 int32_t PIOS_USB_ChangeConnectionState(bool Connected)
 159 {
 160     // In all cases: re-initialise USB HID driver
 161     if (Connected) {
 162         transfer_possible = true;
 163
 164         // TODO: Check SetEPRxValid(ENDP1);
 165
 166 #ifdef USB_LED_ON
 167         USB_LED_ON; // turn the USB led on
 168 #endif
 169     } else {
 170         // Cable disconnected: disable transfers
 171         transfer_possible = false;
 172
 173 #ifdef USB_LED_OFF
 174         USB_LED_OFF; // turn the USB led off
 175 #endif
 176     }
 177
 178     return 0;
 179 }
 180
 181 int32_t PIOS_USB_Reenumerate()
 182 {
 183     /* Force USB reset and power-down (this will also release the USB pins for direct GPIO control) */
 184     _SetCNTR(CNTR_FRES | CNTR_PDWN);
 185
 186     /* Using a "dirty" method to force a re-enumeration: */
 187     /* Force DPM (Pin PA12) low for ca. 10 mS before USB Tranceiver will be enabled */
 188     /* This overrules the external Pull-Up at PA12, and at least Windows & MacOS will enumerate again */
 189     GPIO_InitTypeDef GPIO_InitStructure;
 190     GPIO_StructInit(&GPIO_InitStructure);
 191     GPIO_InitStructure.GPIO_Pin   = GPIO_Pin_12;
 192     GPIO_InitStructure.GPIO_Mode  = GPIO_Mode_Out_PP;
 193     GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;
 194     GPIO_Init(GPIOA, &GPIO_InitStructure);
 195
 196     PIOS_DELAY_WaitmS(50);
 197
 198     /* Release power-down, still hold reset */
 199     _SetCNTR(CNTR_PDWN);
 200     PIOS_DELAY_WaituS(5);
 201
 202     /* CNTR_FRES = 0 */
 203     _SetCNTR(0);
 204
 205     /* Clear pending interrupts */
 206     _SetISTR(0);
 207
 208     /* Configure USB clock */
 209     /* USBCLK = PLLCLK / 1.5 */
 210     RCC_USBCLKConfig(RCC_USBCLKSource_PLLCLK_1Div5);
 211     /* Enable USB clock */
 212     RCC_APB1PeriphClockCmd(RCC_APB1Periph_USB, ENABLE);
 213
 214     return 0;
 215 }
 216
 217 bool PIOS_USB_CableConnected(__attribute__((unused)) uint8_t id)
 218 {
 219     struct pios_usb_dev *usb_dev = (struct pios_usb_dev *)pios_usb_com_id;
 220
 221     if (PIOS_USB_validate(usb_dev) != 0) {
 222         return false;
 223     }
 224
 225     return ((usb_dev->cfg->vsense.gpio->IDR & usb_dev->cfg->vsense.init.GPIO_Pin) != 0) ^ usb_dev->cfg->vsense_active_low;
 226 }
 227
 228 /**
 229  * This function returns the connection status of the USB HID interface
 230  * \return 1: interface available
 231  * \return 0: interface not available
 232  * \note Applications shouldn't call this function directly, instead please use \ref PIOS_COM layer functions
 233  */
 234 bool PIOS_USB_CheckAvailable(uint32_t id)
 235 {
 236     struct pios_usb_dev *usb_dev = (struct pios_usb_dev *)pios_usb_com_id;
 237
 238     if (PIOS_USB_validate(usb_dev) != 0) {
 239         return false;
 240     }
 241
 242     return PIOS_USB_CableConnected(id) && transfer_possible;
 243 }
 244
 245 #endif /* PIOS_INCLUDE_USB_HID */
 246
 247 #endif /* PIOS_INCLUDE_USB */
 248
 249 /**
 250  * @}
 251  * @}
 252  */