amiro-lld / drivers / A3906 / v1 / alld_A3906.h @ 72369edc
History | View | Annotate | Download (3.538 KB)
| 1 | d6728c5b | Thomas Schöpping | /*
|
|---|---|---|---|
| 2 | AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
|
||
| 3 | f125ae07 | Thomas Schöpping | Copyright (C) 2016..2019 Thomas Schöpping et al.
|
| 4 | d6728c5b | Thomas Schöpping | |
| 5 | This program is free software: you can redistribute it and/or modify
|
||
| 6 | f0ca400f | Thomas Schöpping | it under the terms of the GNU Lesser General Public License as published by
|
| 7 | d6728c5b | Thomas Schöpping | the Free Software Foundation, either version 3 of the License, or
|
| 8 | (at your option) any later version.
|
||
| 9 | |||
| 10 | This program is distributed in the hope that it will be useful,
|
||
| 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
| 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
| 13 | f0ca400f | Thomas Schöpping | GNU Lesser General Public License for more details.
|
| 14 | d6728c5b | Thomas Schöpping | |
| 15 | f0ca400f | Thomas Schöpping | You should have received a copy of the GNU Lesser General Public License
|
| 16 | d6728c5b | Thomas Schöpping | along with this program. If not, see <http://www.gnu.org/licenses/>.
|
| 17 | */
|
||
| 18 | |||
| 19 | 5e2f673b | Marc Rothmann | /**
|
| 20 | 9466e34d | Thomas Schöpping | * @file alld_A3906.h
|
| 21 | 5e2f673b | Marc Rothmann | * @brief Motor driver macros and structures.
|
| 22 | *
|
||
| 23 | * @addtogroup lld_motor
|
||
| 24 | * @{
|
||
| 25 | */
|
||
| 26 | |||
| 27 | 9466e34d | Thomas Schöpping | #ifndef AMIROLLD_A3906_H
|
| 28 | #define AMIROLLD_A3906_H
|
||
| 29 | d6728c5b | Thomas Schöpping | |
| 30 | #include <amiro-lld.h> |
||
| 31 | |||
| 32 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 33 | /* CONSTANTS */
|
||
| 34 | /******************************************************************************/
|
||
| 35 | |||
| 36 | d6728c5b | Thomas Schöpping | /**
|
| 37 | * @brief Active state of power pin.
|
||
| 38 | */
|
||
| 39 | #define A3906_LLD_POWER_PIN_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
||
| 40 | |||
| 41 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 42 | /* SETTINGS */
|
||
| 43 | /******************************************************************************/
|
||
| 44 | |||
| 45 | /******************************************************************************/
|
||
| 46 | /* CHECKS */
|
||
| 47 | /******************************************************************************/
|
||
| 48 | |||
| 49 | /******************************************************************************/
|
||
| 50 | /* DATA STRUCTURES AND TYPES */
|
||
| 51 | /******************************************************************************/
|
||
| 52 | |||
| 53 | d6728c5b | Thomas Schöpping | /**
|
| 54 | * @brief A3906 driver struct.
|
||
| 55 | */
|
||
| 56 | typedef struct { |
||
| 57 | 11500ad8 | Thomas Schöpping | const apalControlGpio_t* power_pin; /**< @brief GPIO to enable/disable power of the A3906. */ |
| 58 | d6728c5b | Thomas Schöpping | } A3906Driver; |
| 59 | |||
| 60 | /**
|
||
| 61 | * @brief Power state of the A3906.
|
||
| 62 | */
|
||
| 63 | typedef enum { |
||
| 64 | A3906_LLD_POWER_OFF = 0x00, /**< 'power off' state */ |
||
| 65 | A3906_LLD_POWER_ON = 0x01, /**< 'power on' state */ |
||
| 66 | } a3906_lld_power_t; |
||
| 67 | |||
| 68 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 69 | /* MACROS */
|
||
| 70 | /******************************************************************************/
|
||
| 71 | |||
| 72 | /******************************************************************************/
|
||
| 73 | /* EXTERN DECLARATIONS */
|
||
| 74 | /******************************************************************************/
|
||
| 75 | d6728c5b | Thomas Schöpping | |
| 76 | #ifdef __cplusplus
|
||
| 77 | extern "C" { |
||
| 78 | #endif
|
||
| 79 | apalExitStatus_t a3906_lld_set_power(const A3906Driver* const a3906, const a3906_lld_power_t power_state); |
||
| 80 | apalExitStatus_t a3906_lld_get_power(const A3906Driver* const a3906, a3906_lld_power_t* const power_state); |
||
| 81 | apalExitStatus_t a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const apalPWMwidth_t width); |
||
| 82 | #ifdef __cplusplus
|
||
| 83 | } |
||
| 84 | #endif
|
||
| 85 | |||
| 86 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 87 | /* INLINE FUNCTIONS */
|
||
| 88 | /******************************************************************************/
|
||
| 89 | |||
| 90 | 9466e34d | Thomas Schöpping | #endif /* AMIROLLD_A3906_H */ |
| 91 | 5e2f673b | Marc Rothmann | |
| 92 | /** @} */ |