Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / alld_a3906.c @ 9e45662e

History | View | Annotate | Download (2.79 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
 * @brief Sets the power state of the A3906.
33
 * @param[in]   a3906d      The A3906 driver.
34
 * @param[in]   power_state The new power state to set.
35
 *
36
 * @return The return status indicates whether the function call was successfull.
37
 */
38
inline apalExitStatus_t
39
a3906_lld_set_power(const A3906Driver* const a3906, const a3906_lld_power_t power_state)
40
{
41
  apalDbgAssert(a3906 != NULL);
42

    
43
  // set the output of the pin depending on the activation property
44
  return apalControlGpioSet(a3906->power_pin, (power_state == A3906_LLD_POWER_ON) ? APAL_GPIO_ON : APAL_GPIO_OFF);
45
}
46

    
47
/**
48
 * @brief Gets the current power state of the A3906.
49
 *
50
 * @param[in]   a3906d        The A3906 driver,
51
 * @param[out]  power_state   The currently set power state.
52
 *
53
 * @return The return status indicates whether the function call was successfull.
54
 */
55
inline apalExitStatus_t
56
a3906_lld_get_power(const A3906Driver* const a3906, a3906_lld_power_t* const power_state)
57
{
58
  apalDbgAssert(a3906 != NULL);
59
  apalDbgAssert(power_state != NULL);
60

    
61
  // get current activation state of power gpio
62
  apalControlGpioState_t gpio_state;
63
  apalExitStatus_t status = apalControlGpioGet(a3906->power_pin, &gpio_state);
64
  *power_state = gpio_state == APAL_GPIO_ON ? A3906_LLD_POWER_ON : A3906_LLD_POWER_OFF;
65
  return status;
66
}
67

    
68
/**
69
 * @brief Set the PWM width for one channel.
70
 *
71
 * @param[in]   pwmd      The PWM driver to use.
72
 * @param[in]   channel   The channel of the given PWM driver to set.
73
 * @param[in]   width     The new width to set the PWM to.
74
 *
75
 * @return The return status indicates whether the function call was successfull.
76
 */
77
inline apalExitStatus_t
78
a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const apalPWMwidth_t width)
79
{
80
  apalDbgAssert(pwm != NULL);
81

    
82
  return apalPWMSet(pwm, channel, width);
83
}
84

    
85
#endif /* defined(AMIROLLD_CFG_USE_A3906) */
86

    
87
/** @} */