Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / alld_a3906.h @ cf1f756b

History | View | Annotate | Download (1.85 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
Copyright (C) 2016..2018  Thomas Schöpping et al.
4

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
#ifndef _AMIROLLD_A3906_H_
20
#define _AMIROLLD_A3906_H_
21
22
#include <amiro-lld.h>
23
24
#if defined(AMIROLLD_CFG_USE_A3906) || defined(__DOXYGEN__)
25
26
/**
27
 * @brief Active state of power pin.
28
 */
29
#define A3906_LLD_POWER_PIN_ACTIVE_STATE  APAL_GPIO_ACTIVE_HIGH
30
31
/**
32
 * @brief A3906 driver struct.
33
 */
34
typedef struct {
35 cf1f756b Thomas Schöpping
  apalControlGpio_t* power_pin;   /**< @brief GPIO to enable/disable power of the A3906. */
36 d6728c5b Thomas Schöpping
} A3906Driver;
37
38
/**
39
 * @brief Power state of the A3906.
40
 */
41
typedef enum {
42
  A3906_LLD_POWER_OFF = 0x00,   /**< 'power off' state  */
43
  A3906_LLD_POWER_ON  = 0x01,   /**< 'power on' state   */
44
} a3906_lld_power_t;
45
46
47
#ifdef __cplusplus
48
extern "C" {
49
#endif
50
  apalExitStatus_t a3906_lld_set_power(const A3906Driver* const a3906, const a3906_lld_power_t power_state);
51
  apalExitStatus_t a3906_lld_get_power(const A3906Driver* const a3906, a3906_lld_power_t* const power_state);
52
  apalExitStatus_t a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const apalPWMwidth_t width);
53
#ifdef __cplusplus
54
}
55
#endif
56
57
#endif /* defined(AMIROLLD_CFG_USE_A3906) */
58
59
#endif /* _AMIROLLD_A3906_H_ */