Statistics
| Branch: | Tag: | Revision:

amiro-lld / drivers / A3906 / v1 / alld_A3906.c @ ed9a1bf5

History | View | Annotate | Download (4.094 KB)

1
/*
2
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
3
Copyright (C) 2016..2020  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
/******************************************************************************/
30
/* LOCAL DEFINITIONS                                                          */
31
/******************************************************************************/
32

    
33
/******************************************************************************/
34
/* EXPORTED VARIABLES                                                         */
35
/******************************************************************************/
36

    
37
/******************************************************************************/
38
/* LOCAL TYPES                                                                */
39
/******************************************************************************/
40

    
41
/******************************************************************************/
42
/* LOCAL VARIABLES                                                            */
43
/******************************************************************************/
44

    
45
/******************************************************************************/
46
/* LOCAL FUNCTIONS                                                            */
47
/******************************************************************************/
48

    
49
/******************************************************************************/
50
/* EXPORTED FUNCTIONS                                                         */
51
/******************************************************************************/
52

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

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

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

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

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

    
101
  return apalPWMSet(pwm, channel, width);
102
}
103

    
104
/** @} */
105