Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / alld_a3906.c @ cf1f756b

History | View | Annotate | Download (2.68 KB)

1
/*
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
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
#include <alld_a3906.h>
20

    
21
#if defined(AMIROLLD_CFG_USE_A3906) || defined(__DOXYGEN__)
22

    
23
/**
24
 * @brief Sets the power state of the A3906.
25
 * @param[in]   a3906d      The A3906 driver.
26
 * @param[in]   power_state The new power state to set.
27
 *
28
 * @return The return status indicates whether the function call was successfull.
29
 */
30
inline apalExitStatus_t
31
a3906_lld_set_power(const A3906Driver* const a3906, const a3906_lld_power_t power_state)
32
{
33
  apalDbgAssert(a3906 != NULL);
34

    
35
  // set the output of the pin depending on the activation property
36
  return apalControlGpioSet(a3906->power_pin, (power_state == A3906_LLD_POWER_ON) ? APAL_GPIO_ON : APAL_GPIO_OFF);
37
}
38

    
39
/**
40
 * @brief Gets the current power state of the A3906.
41
 *
42
 * @param[in]   a3906d        The A3906 driver,
43
 * @param[out]  power_state   The currently set power state.
44
 *
45
 * @return The return status indicates whether the function call was successfull.
46
 */
47
inline apalExitStatus_t
48
a3906_lld_get_power(const A3906Driver* const a3906, a3906_lld_power_t* const power_state)
49
{
50
  apalDbgAssert(a3906 != NULL);
51
  apalDbgAssert(power_state != NULL);
52

    
53
  // get current activation state of power gpio
54
  apalControlGpioState_t gpio_state;
55
  apalExitStatus_t status = apalControlGpioGet(a3906->power_pin, &gpio_state);
56
  *power_state = gpio_state == APAL_GPIO_ON ? A3906_LLD_POWER_ON : A3906_LLD_POWER_OFF;
57
  return status;
58
}
59

    
60
/**
61
 * @brief Set the PWM width for one channel.
62
 *
63
 * @param[in]   pwmd      The PWM driver to use.
64
 * @param[in]   channel   The channel of the given PWM driver to set.
65
 * @param[in]   width     The new width to set the PWM to.
66
 *
67
 * @return The return status indicates whether the function call was successfull.
68
 */
69
inline apalExitStatus_t
70
a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const apalPWMwidth_t width)
71
{
72
  apalDbgAssert(pwm != NULL);
73

    
74
  return apalPWMSet(pwm, channel, width);
75
}
76

    
77
#endif /* defined(AMIROLLD_CFG_USE_A3906) */