flight/pios/inc/pios_rcvr.h

   1 /**
   2  ******************************************************************************
   3  * @addtogroup PIOS PIOS Core hardware abstraction layer
   4  * @{
   5  * @addtogroup PIOS_RCVR RCVR layer functions
   6  * @brief Hardware communication layer
   7  * @{
   8  *
   9  * @file       pios_rcvr.h
  10  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  11  * @brief      RCVR layer functions header
  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_RCVR_H
  32 #define PIOS_RCVR_H
  33
  34 struct pios_rcvr_driver {
  35     void    (*init)(uint32_t id);
  36     int32_t (*read)(uint32_t id, uint8_t channel);
  37     xSemaphoreHandle (*get_semaphore)(uint32_t id, uint8_t channel);
  38     uint8_t (*get_quality)(uint32_t id);
  39 };
  40
  41 /* Public Functions */
  42 extern int32_t PIOS_RCVR_Read(uint32_t rcvr_id, uint8_t channel);
  43 extern uint8_t PIOS_RCVR_GetQuality(uint32_t rcvr_id);
  44 extern xSemaphoreHandle PIOS_RCVR_GetSemaphore(uint32_t rcvr_id, uint8_t channel);
  45
  46 /*! Define error codes for PIOS_RCVR_Get */
  47 enum PIOS_RCVR_errors {
  48     /*! Indicates that a failsafe condition or missing receiver detected for that channel */
  49     PIOS_RCVR_TIMEOUT  = -1,
  50     /*! Channel is invalid for this driver (usually out of range supported) */
  51     PIOS_RCVR_INVALID  = -2,
  52     /*! Indicates that the driver for this channel has not been initialized */
  53     PIOS_RCVR_NODRIVER = -3
  54 };
  55
  56 #endif /* PIOS_RCVR_H */
  57
  58 /**
  59  * @}
  60  * @}
  61  */