/periphALtypes.h - Annotate - AMiRo-OS - Research for Cognitive Interaction

amiro-lld / periphALtypes.h @ 7021191e

History | View | Annotate | Download (10.305 KB)

-            d6728c5b
+/*
 AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
-            f125ae07
+Copyright (C) 2016..2019  Thomas Schöpping et al.
-            d6728c5b
+            Thomas Schöpping
 This program is free software: you can redistribute it and/or modify
-            f0ca400f
+it under the terms of the GNU Lesser General Public License as published by
-            d6728c5b
+the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-            f0ca400f
+GNU Lesser General Public License for more details.
-            d6728c5b
+            Thomas Schöpping
-            f0ca400f
+You should have received a copy of the GNU Lesser General Public License
-            d6728c5b
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
-c47f14b
+#ifndef AMIROLLD_PERIPHALTYPES_H
 #define AMIROLLD_PERIPHALTYPES_H
-            d6728c5b
+            Thomas Schöpping
 /*============================================================================*/
 /* DEPENDENCIES                                                               */
 /*============================================================================*/
-            a627f4dd
+#include <amiro-lld.h>
-            d6728c5b
+#include <stdint.h>
 /*============================================================================*/
 /* GENERAL                                                                    */
 /*============================================================================*/
 /**
  * @brief Time measurement type (in microseconds).
  */
-            cf1f756b
+#if !defined(AMIROLLD_CFG_TIME_SIZE)
   #error "AMIROLLD_CFG_TIME_SIZE not defined in alldconf.h"
 #elif (AMIROLLD_CFG_TIME_SIZE == 8)
   typedef uint8_t     apalTime_t;
 #elif (AMIROLLD_CFG_TIME_SIZE == 16)
   typedef uint16_t    apalTime_t;
 #elif (AMIROLLD_CFG_TIME_SIZE == 32)
   typedef uint32_t    apalTime_t;
 #elif (AMIROLLD_CFG_TIME_SIZE == 64)
   typedef uint64_t    apalTime_t;
 #else
   #error "AMIROLLD_CFG_TIME_SIZE must be 8, 16, 32 or 64!"
 #endif
-            d6728c5b
+            Thomas Schöpping
 /**
  * @brief Status values used as return value for all (or most) function calls.
  * @note  The status can be used as mask of flags.
  */
-            7021191e
+typedef int8_t apalExitStatus_t;
 /**
  * @brief   Status value for success (no error or warning occurred).
  */
 #define APAL_STATUS_OK                          ((apalExitStatus_t)0)
 #define APAL_STATUS_SUCCESS                     ((apalExitStatus_t)0)
 /**
  * @brief   Status value for unspecified failure.
  */
 #define APAL_STATUS_ERROR                       ((apalExitStatus_t)-1)
 #define APAL_STATUS_FAILURE                     ((apalExitStatus_t)-1)
 /**
  * @brief   Status value for timeout failure.
  */
 #define APAL_STATUS_TIMEOUT                     ((apalExitStatus_t)-2)
 /**
  * @brief   Status value for failure because of invalid arguments.
  */
 #define APAL_STATUS_INVALIDARGUMENTS            ((apalExitStatus_t)-4)
 /**
  * @brief   Status value for failure because the function is not available/implemented.
  */
 #define APAL_STATUS_UNAVAILABLE                 ((apalExitStatus_t)-8)
 /**
  * @brief   Status value for unspecified warning.
  */
 #define APAL_STATUS_WARNING                     ((apalExitStatus_t)1)
-            d6728c5b
+            Thomas Schöpping
 /*============================================================================*/
 /* GPIO                                                                       */
 /*============================================================================*/
 /**
  * @brief   Forward declaration.
  * @details Struct must be defined in 'periphAL.h'.
  */
 typedef struct apalGpio_t apalGpio_t;
 /**
  * @brief Status values to read/write a GPIO port.
  */
-            7021191e
+typedef uint8_t apalGpioState_t;
 /**
  * @brief   GPIO physical low state.
  */
 #define APAL_GPIO_LOW                           ((apalGpioState_t)0)
-            d6728c5b
+            Thomas Schöpping
 /**
-            7021191e
+ * @brief   GPIO physical high state.
-            d6728c5b
+ */
-            7021191e
+#define APAL_GPIO_HIGH                          ((apalGpioState_t)1)
 /**
  * @brief   Invert a physical GPIO state.
+ *
  * @param[in] state   GPIO state to invert.
+ *
  * @return  Inverted physical GPIO state.
  */
 #define APAL_GPIO_STATE_INVERT(state) (                                       \
   (apalGpioState_t)state ^ APAL_GPIO_HIGH                                     \
+)
 /**
  * @brief Logical status values to turn a control GPIO 'on' and 'off'.
  */
 typedef uint8_t apalControlGpioState_t;
 /**
  * @brief   GPIO logical off state.
  */
 #define APAL_GPIO_OFF                           ((apalControlGpioState_t)0)
 /**
  * @brief   GPIO logical on state.
  */
 #define APAL_GPIO_ON                            ((apalControlGpioState_t)1)
-            d6728c5b
+            Thomas Schöpping
 /**
  * @brief   Polarity state of the control GPIO.
  */
-            7021191e
+typedef uint8_t apalGpioActive_t;
 /**
  * @brief   The control GPIO is never defined to be 'on' (does not apply).
  */
 #define APAL_GPIO_ACTIVE_NONE                   ((apalGpioActive_t)0)
 /**
  * @brief   The control GPIO is defined to be 'on' when it is phsically low.
  */
 #define APAL_GPIO_ACTIVE_LOW                    ((apalGpioActive_t)1)
 /**
  * @brief   The control GPIO is defined to be 'on' when it is physically high.
  */
 #define APAL_GPIO_ACTIVE_HIGH                   ((apalGpioActive_t)2)
 /**
  * @brief   The control GPIO is defined to be always 'on'.
  */
 #define APAL_GPIO_ACTIVE_ANY                    ((apalGpioActive_t)3)
 /**
  * @brief   Invert a GPIO active state.
  * @details The active state is inverted only if it was either low or high.
  *          In case it was set to none or any, the value is not modified.
+ *
  * @param[in] active  Active state to be inverted.
+ *
  * @return  Inverted active state.
  */
 #define APAL_GPIO_ACTIVE_INVERT(active) (                                     \
   (((apalGpioActive_t)active & APAL_GPIO_ACTIVE_LOW) ^                        \
    ((apalGpioActive_t)active & APAL_GPIO_ACTIVE_HIGH)) ?                      \
   ((apalGpioActive_t)active ^ APAL_GPIO_ACTIVE_ANY) :                         \
   ((apalGpioActive_t)active)                                                  \
+)
-            d6728c5b
+            Thomas Schöpping
 /**
-            cf1f756b
+ * @brief   Signal direction for the control GPIO.
  */
-            7021191e
+typedef uint8_t apalGpioDirection_t;
 /**
  * @brief   Signal direction for the control GPIO is undefined.
  */
 #define APAL_GPIO_DIRECTION_UNDEFINED           ((apalGpioDirection_t)0)
 /**
  * @brief   Signal direction for the control GPIO is input only.
  */
 #define APAL_GPIO_DIRECTION_INPUT               ((apalGpioDirection_t)1)
 /**
  * @brief   Signal direction for the control GPIO is output only.
  */
 #define APAL_GPIO_DIRECTION_OUTPUT              ((apalGpioDirection_t)2)
 /**
  * @brief   Signal direction for the control GPIO is didirectional.
  */
 #define APAL_GPIO_DIRECTION_BIDIRECTIONAL       ((apalGpioDirection_t)3)
 /**
  * @brief   Informative or effective signal edge for control GPIOs.
  */
 typedef uint8_t apalGpioEdge_t;
-            cf1f756b
+            Thomas Schöpping
 /**
-            7021191e
+ * @brief   No edges indicate an interrupt or trigger an action.
-            d6728c5b
+ */
-            7021191e
+#define APAL_GPIO_EDGE_NONE                     ((apalGpioEdge_t)0)
-            d6728c5b
+            Thomas Schöpping
 /**
-            7021191e
+ * @brief   Rising edges indicate an interrupt or trigger an action.
  */
 #define APAL_GPIO_EDGE_RISING                   ((apalGpioEdge_t)1)
 /**
  * @brief   Falling edges indicate an interrupt or trigger an action.
  */
 #define APAL_GPIO_EDGE_FALLING                  ((apalGpioEdge_t)2)
 /**
  * @brief   Both rising and falling edges indicate an interrupt or trigger an action.
  */
 #define APAL_GPIO_EDGE_BOTH                     ((apalGpioEdge_t)3)
 /**
  * @brief   Inverts the value of the informative or effective signal edge for interrupts.
-            cf1f756b
+ * @details Rising edge is inverted to falling and vice versa.
  *          If none or both edges are enabled, the identical value is returned.
-            d6728c5b
+ */
-            7021191e
+#define APAL_GPIO_EDGE_INVERT(edge) (                                         \
   (((apalGpioEdge_t)edge & APAL_GPIO_EDGE_RISING) ^                           \
    ((apalGpioEdge_t)edge & APAL_GPIO_EDGE_FALLING)) ?                         \
   ((apalGpioEdge_t)edge ^ APAL_GPIO_EDGE_BOTH) :                              \
   ((apalGpioEdge_t)edge)                                                      \
+)
-            d6728c5b
+            Thomas Schöpping
 /**
  * @brief Control GPIO meta information
  */
 typedef struct {
-            cf1f756b
+  apalGpioDirection_t direction : 2;  /**< Direction configuration for according signals */
-            7021191e
+  apalGpioActive_t active       : 2;  /**< Active state of the GPIO */
-            d6728c5b
+  apalGpioEdge_t edge           : 2;  /**< Edge configuration for according signals */
 } apalGpioMeta_t;
 /**
  * @brief Control GPIO type.
  */
 typedef struct {
   apalGpio_t* gpio;     /**< The GPIO to use.                 */
   apalGpioMeta_t meta;  /**< Meta information about the GPIO. */
 } apalControlGpio_t;
 /*============================================================================*/
 /* PWM                                                                        */
 /*============================================================================*/
 /**
  * @brief PWM channel type.
  */
 typedef uint8_t   apalPWMchannel_t;
 /**
  * @brief PWM width type.
  */
 typedef uint16_t  apalPWMwidth_t;
 /**
  * @brief PWM frequency type.
  */
 typedef uint32_t  apalPWMfrequency_t;
 /**
  * @brief PWM period time.
  */
 typedef uint32_t  apalPWMperiod_t;
 /**
-            7021191e
+ * @brief   PWM width to turn off the PWM.
-            d6728c5b
+ */
-            7021191e
+#define APAL_PWM_WIDTH_OFF                      ((apalPWMwidth_t)0x0000u)
 /**
  * @brief   Minimum allowed PWM width.
  */
 #define APAL_PWM_WIDTH_MIN                      ((apalPWMwidth_t)0x0000u)
 /**
  * @brief   Maximum allowed PWM width.
  */
 #define APAL_PWM_WIDTH_MAX                      ((apalPWMwidth_t)0xFFFFu)
-            d6728c5b
+            Thomas Schöpping
 /*============================================================================*/
 /* QEI                                                                        */
 /*============================================================================*/
 /**
  * @brief QEI counter type.
  */
 typedef uint32_t  apalQEICount_t;
 /**
  * @brief Direction of the QEI.
  */
-            7021191e
+typedef uint8_t apalQEIDirection_t;
 /*
  * @brief   QEI counts upwards.
  */
 #define APAL_QEI_DIRECTION_UP                   ((apalQEIDirection_t)0)
 /*
  * @brief   QEI counts downwards.
  */
 #define APAL_QEI_DIRECTION_DOWN                 ((apalQEIDirection_t)1)
-            d6728c5b
+            Thomas Schöpping
 /*============================================================================*/
 /* I2C                                                                        */
 /*============================================================================*/
 /**
  * @brief I2C address type.
  */
 typedef uint16_t apalI2Caddr_t;
 /*============================================================================*/
 /* SPI                                                                        */
 /*============================================================================*/
-            7021191e
+/* nothing defined for SPI */
-            d6728c5b
+            Thomas Schöpping
-c47f14b
+#endif /* AMIROLLD_PERIPHALTYPES_H */