amiro-lld / include / A3906 / v1 / alld_A3906_v1.h @ 7aa812e9
History | View | Annotate | Download (3.713 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 | 1d5bcc82 | Thomas Schöpping | * @file alld_A3906_v1.h
|
21 | 5e2f673b | Marc Rothmann | * @brief Motor driver macros and structures.
|
22 | *
|
||
23 | * @addtogroup lld_motor
|
||
24 | * @{
|
||
25 | */
|
||
26 | |||
27 | 1d5bcc82 | Thomas Schöpping | #ifndef AMIROLLD_A3906_V1_H
|
28 | #define AMIROLLD_A3906_V1_H
|
||
29 | d6728c5b | Thomas Schöpping | |
30 | #include <amiro-lld.h> |
||
31 | |||
32 | 1d5bcc82 | Thomas Schöpping | #if (defined(AMIROLLD_CFG_A3906) && (AMIROLLD_CFG_A3906 == 1)) || defined(__DOXYGEN__) |
33 | d6728c5b | Thomas Schöpping | |
34 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
35 | /* CONSTANTS */
|
||
36 | /******************************************************************************/
|
||
37 | |||
38 | d6728c5b | Thomas Schöpping | /**
|
39 | * @brief Active state of power pin.
|
||
40 | */
|
||
41 | #define A3906_LLD_POWER_PIN_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
||
42 | |||
43 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
44 | /* SETTINGS */
|
||
45 | /******************************************************************************/
|
||
46 | |||
47 | /******************************************************************************/
|
||
48 | /* CHECKS */
|
||
49 | /******************************************************************************/
|
||
50 | |||
51 | /******************************************************************************/
|
||
52 | /* DATA STRUCTURES AND TYPES */
|
||
53 | /******************************************************************************/
|
||
54 | |||
55 | d6728c5b | Thomas Schöpping | /**
|
56 | * @brief A3906 driver struct.
|
||
57 | */
|
||
58 | typedef struct { |
||
59 | 11500ad8 | Thomas Schöpping | const apalControlGpio_t* power_pin; /**< @brief GPIO to enable/disable power of the A3906. */ |
60 | d6728c5b | Thomas Schöpping | } A3906Driver; |
61 | |||
62 | /**
|
||
63 | * @brief Power state of the A3906.
|
||
64 | */
|
||
65 | typedef enum { |
||
66 | A3906_LLD_POWER_OFF = 0x00, /**< 'power off' state */ |
||
67 | A3906_LLD_POWER_ON = 0x01, /**< 'power on' state */ |
||
68 | } a3906_lld_power_t; |
||
69 | |||
70 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
71 | /* MACROS */
|
||
72 | /******************************************************************************/
|
||
73 | |||
74 | /******************************************************************************/
|
||
75 | /* EXTERN DECLARATIONS */
|
||
76 | /******************************************************************************/
|
||
77 | d6728c5b | Thomas Schöpping | |
78 | #ifdef __cplusplus
|
||
79 | extern "C" { |
||
80 | #endif
|
||
81 | apalExitStatus_t a3906_lld_set_power(const A3906Driver* const a3906, const a3906_lld_power_t power_state); |
||
82 | apalExitStatus_t a3906_lld_get_power(const A3906Driver* const a3906, a3906_lld_power_t* const power_state); |
||
83 | apalExitStatus_t a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const apalPWMwidth_t width); |
||
84 | #ifdef __cplusplus
|
||
85 | } |
||
86 | #endif
|
||
87 | |||
88 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
89 | /* INLINE FUNCTIONS */
|
||
90 | /******************************************************************************/
|
||
91 | |||
92 | 1d5bcc82 | Thomas Schöpping | #endif /* defined(AMIROLLD_CFG_USE_A3906) && (AMIROLLD_CFG_USE_A3906 == 1) */ |
93 | d6728c5b | Thomas Schöpping | |
94 | 1d5bcc82 | Thomas Schöpping | #endif /* AMIROLLD_A3906_V1_H */ |
95 | 5e2f673b | Marc Rothmann | |
96 | /** @} */ |