flight/pios/inc/pios_usart_priv.h

   1 /**
   2  ******************************************************************************
   3  * @addtogroup PIOS PIOS Core hardware abstraction layer
   4  * @{
   5  * @addtogroup   PIOS_USART USART Functions
   6  * @brief PIOS interface for USART port
   7  * @{
   8  *
   9  * @file       pios_usart_priv.h
  10  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  11  * @brief      USART private definitions.
  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 #ifndef PIOS_USART_PRIV_H
  32 #define PIOS_USART_PRIV_H
  33
  34 #include <pios.h>
  35 #include <pios_stm32.h>
  36 #include "fifo_buffer.h"
  37 #include "pios_usart.h"
  38
  39 extern const struct pios_com_driver pios_usart_com_driver;
  40
  41 struct pios_usart_cfg {
  42     USART_TypeDef     *regs;
  43     uint32_t remap; /* GPIO_Remap_* */
  44     struct stm32_gpio rx;
  45     struct stm32_gpio tx;
  46     struct stm32_gpio dtr;
  47
  48     /* provide hook for board specific ioctls */
  49     int32_t (*ioctl)(uint32_t id, uint32_t ctl, void *param);
  50 };
  51
  52 extern int32_t PIOS_USART_Init(uint32_t *usart_id, const struct pios_usart_cfg *cfg);
  53
  54 const struct pios_usart_cfg *PIOS_USART_GetConfig(uint32_t usart_id);
  55
  56 #endif /* PIOS_USART_PRIV_H */
  57
  58 /**
  59  * @}
  60  * @}
  61  */