Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / alld_a3906.c @ 21076167

History | View | Annotate | Download (4.2 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.c
21
 * @brief   Motor driver functions.
22
 *
23
 * @addtogroup lld_motor
24
 * @{
25
 */
26

    
27
#include <alld_a3906.h>
28

    
29
#if defined(AMIROLLD_CFG_USE_A3906) || defined(__DOXYGEN__)
30

    
31
/******************************************************************************/
32
/* LOCAL DEFINITIONS                                                          */
33
/******************************************************************************/
34

    
35
/******************************************************************************/
36
/* EXPORTED VARIABLES                                                         */
37
/******************************************************************************/
38

    
39
/******************************************************************************/
40
/* LOCAL TYPES                                                                */
41
/******************************************************************************/
42

    
43
/******************************************************************************/
44
/* LOCAL VARIABLES                                                            */
45
/******************************************************************************/
46

    
47
/******************************************************************************/
48
/* LOCAL FUNCTIONS                                                            */
49
/******************************************************************************/
50

    
51
/******************************************************************************/
52
/* EXPORTED FUNCTIONS                                                         */
53
/******************************************************************************/
54

    
55
/**
56
 * @brief Sets the power state of the A3906.
57
 * @param[in]   a3906d      The A3906 driver.
58
 * @param[in]   power_state The new power state to set.
59
 *
60
 * @return The return status indicates whether the function call was successfull.
61
 */
62
apalExitStatus_t a3906_lld_set_power(const A3906Driver* const a3906, const a3906_lld_power_t power_state)
63
{
64
  apalDbgAssert(a3906 != NULL);
65

    
66
  // set the output of the pin depending on the activation property
67
  return apalControlGpioSet(a3906->power_pin, (power_state == A3906_LLD_POWER_ON) ? APAL_GPIO_ON : APAL_GPIO_OFF);
68
}
69

    
70
/**
71
 * @brief Gets the current power state of the A3906.
72
 *
73
 * @param[in]   a3906d        The A3906 driver,
74
 * @param[out]  power_state   The currently set power state.
75
 *
76
 * @return The return status indicates whether the function call was successfull.
77
 */
78
apalExitStatus_t a3906_lld_get_power(const A3906Driver* const a3906, a3906_lld_power_t* const power_state)
79
{
80
  apalDbgAssert(a3906 != NULL);
81
  apalDbgAssert(power_state != NULL);
82

    
83
  // get current activation state of power gpio
84
  apalControlGpioState_t gpio_state;
85
  apalExitStatus_t status = apalControlGpioGet(a3906->power_pin, &gpio_state);
86
  *power_state = gpio_state == APAL_GPIO_ON ? A3906_LLD_POWER_ON : A3906_LLD_POWER_OFF;
87
  return status;
88
}
89

    
90
/**
91
 * @brief Set the PWM width for one channel.
92
 *
93
 * @param[in]   pwmd      The PWM driver to use.
94
 * @param[in]   channel   The channel of the given PWM driver to set.
95
 * @param[in]   width     The new width to set the PWM to.
96
 *
97
 * @return The return status indicates whether the function call was successfull.
98
 */
99
apalExitStatus_t a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const apalPWMwidth_t width)
100
{
101
  apalDbgAssert(pwm != NULL);
102

    
103
  return apalPWMSet(pwm, channel, width);
104
}
105

    
106
#endif /* defined(AMIROLLD_CFG_USE_A3906) */
107

    
108
/** @} */