amiro-lld / source / alld_a3906.c @ ef078306
History | View | Annotate | Download (4.218 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 | f125ae07 | Thomas Schöpping | Copyright (C) 2016..2019 Thomas Schöpping et al.
|
| 4 | d6728c5b | Thomas Schöpping | |
| 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 | 5e2f673b | Marc Rothmann | /**
|
| 20 | * @file alld_a3906.c
|
||
| 21 | * @brief Motor driver functions.
|
||
| 22 | *
|
||
| 23 | * @addtogroup lld_motor
|
||
| 24 | * @{
|
||
| 25 | */
|
||
| 26 | |||
| 27 | d6728c5b | Thomas Schöpping | #include <alld_a3906.h> |
| 28 | |||
| 29 | #if defined(AMIROLLD_CFG_USE_A3906) || defined(__DOXYGEN__)
|
||
| 30 | |||
| 31 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 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 | d6728c5b | Thomas Schöpping | /**
|
| 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 | inline apalExitStatus_t
|
||
| 63 | a3906_lld_set_power(const A3906Driver* const a3906, const a3906_lld_power_t power_state) |
||
| 64 | {
|
||
| 65 | apalDbgAssert(a3906 != NULL);
|
||
| 66 | |||
| 67 | // set the output of the pin depending on the activation property
|
||
| 68 | cf1f756b | Thomas Schöpping | return apalControlGpioSet(a3906->power_pin, (power_state == A3906_LLD_POWER_ON) ? APAL_GPIO_ON : APAL_GPIO_OFF);
|
| 69 | d6728c5b | Thomas Schöpping | } |
| 70 | |||
| 71 | /**
|
||
| 72 | * @brief Gets the current power state of the A3906.
|
||
| 73 | *
|
||
| 74 | * @param[in] a3906d The A3906 driver,
|
||
| 75 | * @param[out] power_state The currently set power state.
|
||
| 76 | *
|
||
| 77 | * @return The return status indicates whether the function call was successfull.
|
||
| 78 | */
|
||
| 79 | inline apalExitStatus_t
|
||
| 80 | a3906_lld_get_power(const A3906Driver* const a3906, a3906_lld_power_t* const power_state) |
||
| 81 | {
|
||
| 82 | apalDbgAssert(a3906 != NULL);
|
||
| 83 | apalDbgAssert(power_state != NULL);
|
||
| 84 | |||
| 85 | // get current activation state of power gpio
|
||
| 86 | apalControlGpioState_t gpio_state; |
||
| 87 | cf1f756b | Thomas Schöpping | apalExitStatus_t status = apalControlGpioGet(a3906->power_pin, &gpio_state); |
| 88 | d6728c5b | Thomas Schöpping | *power_state = gpio_state == APAL_GPIO_ON ? A3906_LLD_POWER_ON : A3906_LLD_POWER_OFF; |
| 89 | return status;
|
||
| 90 | } |
||
| 91 | |||
| 92 | /**
|
||
| 93 | * @brief Set the PWM width for one channel.
|
||
| 94 | *
|
||
| 95 | * @param[in] pwmd The PWM driver to use.
|
||
| 96 | * @param[in] channel The channel of the given PWM driver to set.
|
||
| 97 | * @param[in] width The new width to set the PWM to.
|
||
| 98 | *
|
||
| 99 | * @return The return status indicates whether the function call was successfull.
|
||
| 100 | */
|
||
| 101 | inline apalExitStatus_t
|
||
| 102 | a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const apalPWMwidth_t width) |
||
| 103 | {
|
||
| 104 | apalDbgAssert(pwm != NULL);
|
||
| 105 | |||
| 106 | return apalPWMSet(pwm, channel, width);
|
||
| 107 | } |
||
| 108 | |||
| 109 | #endif /* defined(AMIROLLD_CFG_USE_A3906) */ |
||
| 110 | 5e2f673b | Marc Rothmann | |
| 111 | /** @} */ |