amiro-lld / include / alld_a3906.h @ f125ae07
History | View | Annotate | Download (1.98 KB)
1 |
/*
|
---|---|
2 |
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
|
3 |
Copyright (C) 2016..2019 Thomas Schöpping et al.
|
4 |
|
5 |
This program is free software: you can redistribute it and/or modify
|
6 |
it under the terms of the GNU Lesser General Public License as published by
|
7 |
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 |
GNU Lesser General Public License for more details.
|
14 |
|
15 |
You should have received a copy of the GNU Lesser General Public License
|
16 |
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
17 |
*/
|
18 |
|
19 |
/**
|
20 |
* @file alld_a3906.h
|
21 |
* @brief Motor driver macros and structures.
|
22 |
*
|
23 |
* @addtogroup lld_motor
|
24 |
* @{
|
25 |
*/
|
26 |
|
27 |
#ifndef _AMIROLLD_A3906_H_
|
28 |
#define _AMIROLLD_A3906_H_
|
29 |
|
30 |
#include <amiro-lld.h> |
31 |
|
32 |
#if defined(AMIROLLD_CFG_USE_A3906) || defined(__DOXYGEN__)
|
33 |
|
34 |
/**
|
35 |
* @brief Active state of power pin.
|
36 |
*/
|
37 |
#define A3906_LLD_POWER_PIN_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
38 |
|
39 |
/**
|
40 |
* @brief A3906 driver struct.
|
41 |
*/
|
42 |
typedef struct { |
43 |
const apalControlGpio_t* power_pin; /**< @brief GPIO to enable/disable power of the A3906. */ |
44 |
} A3906Driver; |
45 |
|
46 |
/**
|
47 |
* @brief Power state of the A3906.
|
48 |
*/
|
49 |
typedef enum { |
50 |
A3906_LLD_POWER_OFF = 0x00, /**< 'power off' state */ |
51 |
A3906_LLD_POWER_ON = 0x01, /**< 'power on' state */ |
52 |
} a3906_lld_power_t; |
53 |
|
54 |
|
55 |
#ifdef __cplusplus
|
56 |
extern "C" { |
57 |
#endif
|
58 |
apalExitStatus_t a3906_lld_set_power(const A3906Driver* const a3906, const a3906_lld_power_t power_state); |
59 |
apalExitStatus_t a3906_lld_get_power(const A3906Driver* const a3906, a3906_lld_power_t* const power_state); |
60 |
apalExitStatus_t a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const apalPWMwidth_t width); |
61 |
#ifdef __cplusplus
|
62 |
} |
63 |
#endif
|
64 |
|
65 |
#endif /* defined(AMIROLLD_CFG_USE_A3906) */ |
66 |
|
67 |
#endif /* _AMIROLLD_A3906_H_ */ |
68 |
|
69 |
/** @} */
|