amiro-lld / source / PKxxxExxx / v1 / alld_PKxxxExxx_v1.c @ 1d5bcc82
History | View | Annotate | Download (4.04 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 | 1d5bcc82 | Thomas Schöpping | * @file alld_PKxxxExxx_v1.c
|
21 | 5e2f673b | Marc Rothmann | * @brief Buzzer function implementations.
|
22 | *
|
||
23 | * @addtogroup lld_buzzer
|
||
24 | * @{
|
||
25 | */
|
||
26 | |||
27 | 1d5bcc82 | Thomas Schöpping | #include <alld_PKxxxExxx.h> |
28 | d6728c5b | Thomas Schöpping | |
29 | 1d5bcc82 | Thomas Schöpping | #if (defined(AMIROLLD_CFG_PKxxxExxx) && (AMIROLLD_CFG_PKxxxExxx == 1)) || defined(__DOXYGEN__) |
30 | d6728c5b | Thomas Schöpping | |
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 Check the configuration of the PWM for the correct frequency.
|
||
57 | * @param[in] pwm The PWM driver to check.
|
||
58 | * @return The return status indicates whether the function call was successful.
|
||
59 | */
|
||
60 | 1d5bcc82 | Thomas Schöpping | apalExitStatus_t pkxxxexxx_lld_checkPWMconfiguration(apalPWMDriver_t* pwm) |
61 | d6728c5b | Thomas Schöpping | { |
62 | apalDbgAssert(pwm != NULL);
|
||
63 | |||
64 | apalPWMfrequency_t frequency = 0;
|
||
65 | apalPWMperiod_t period = 0;
|
||
66 | apalExitStatus_t status = apalPWMGetFrequency(pwm, &frequency); |
||
67 | status |= apalPWMGetPeriod(pwm, &period); |
||
68 | 1d5bcc82 | Thomas Schöpping | if (frequency / period == PKxxxExxx_LLD_FREQUENCY_SPEC) {
|
69 | d6728c5b | Thomas Schöpping | status |= APAL_STATUS_OK; |
70 | 1d5bcc82 | Thomas Schöpping | } else if (frequency / period >= PKxxxExxx_LLD_FREQUENCY_MIN && |
71 | frequency / period <= PKxxxExxx_LLD_FREQUENCY_MAX) { |
||
72 | d6728c5b | Thomas Schöpping | status |= APAL_STATUS_WARNING; |
73 | } else {
|
||
74 | status |= APAL_STATUS_INVALIDARGUMENTS; |
||
75 | } |
||
76 | |||
77 | return status;
|
||
78 | } |
||
79 | |||
80 | /**
|
||
81 | * @brief Turns the buzzer on or off.
|
||
82 | * @param[in] pwm The PWM driver to use
|
||
83 | * @param[in] channel The PWM channel to enable/disable.
|
||
84 | * @param[in] enable Specifies whether the buzzer shall be turned on (true) or off (false).
|
||
85 | * @return The return status indicates whether the function call was successful.
|
||
86 | */
|
||
87 | 1d5bcc82 | Thomas Schöpping | apalExitStatus_t pkxxxexxx_lld_enable(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const bool enable) |
88 | d6728c5b | Thomas Schöpping | { |
89 | apalDbgAssert(pwm != NULL);
|
||
90 | |||
91 | if (enable) {
|
||
92 | apalPWMperiod_t period = 0;
|
||
93 | apalExitStatus_t status = apalPWMGetFrequency(pwm, &period); |
||
94 | status |= apalPWMSet(pwm, channel, period/2);
|
||
95 | return status;
|
||
96 | } else {
|
||
97 | return apalPWMSet(pwm, channel, 0); |
||
98 | } |
||
99 | } |
||
100 | |||
101 | 1d5bcc82 | Thomas Schöpping | #endif /* defined(AMIROLLD_CFG_PKxxxExxx) && (AMIROLLD_CFG_PKxxxExxx == 1) */ |
102 | 5e2f673b | Marc Rothmann | |
103 | /** @} */ |