Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / alld_pklcs1212e4001.c @ ef078306

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
 * @file    alld_pklcs1212e4001.c
21
 * @brief   Buzzer function implementations.
22
 *
23
 * @addtogroup lld_buzzer
24
 * @{
25
 */
26
27 d6728c5b Thomas Schöpping
#include <alld_pklcs1212e4001.h>
28
29
#if defined(AMIROLLD_CFG_USE_PKLCS1212E4001) || 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 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
inline apalExitStatus_t
61
pklcs1212e4001_lld_checkPWMconfiguration(apalPWMDriver_t* pwm)
62
{
63
  apalDbgAssert(pwm != NULL);
64
65
  apalPWMfrequency_t frequency = 0;
66
  apalPWMperiod_t period = 0;
67
  apalExitStatus_t status = apalPWMGetFrequency(pwm, &frequency);
68
  status |= apalPWMGetPeriod(pwm, &period);
69
  if (frequency / period == PKLCS1212E4001_LLD_FREQUENCY_SPEC) {
70
    status |= APAL_STATUS_OK;
71
  } else if (frequency / period >= PKLCS1212E4001_LLD_FREQUENCY_MIN &&
72
             frequency / period <= PKLCS1212E4001_LLD_FREQUENCY_MAX) {
73
    status |= APAL_STATUS_WARNING;
74
  } else {
75
    status |= APAL_STATUS_INVALIDARGUMENTS;
76
  }
77
78
  return status;
79
}
80
81
/**
82
 * @brief Turns the buzzer on or off.
83
 * @param[in] pwm       The PWM driver to use
84
 * @param[in] channel   The PWM channel to enable/disable.
85
 * @param[in] enable    Specifies whether the buzzer shall be turned on (true) or off (false).
86
 * @return  The return status indicates whether the function call was successful.
87
 */
88
inline apalExitStatus_t
89
pklcs1212e4001_lld_enable(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const bool enable)
90
{
91
  apalDbgAssert(pwm != NULL);
92
93
  if (enable) {
94
    apalPWMperiod_t period = 0;
95
    apalExitStatus_t status = apalPWMGetFrequency(pwm, &period);
96
    status |= apalPWMSet(pwm, channel, period/2);
97
    return status;
98
  } else {
99
    return apalPWMSet(pwm, channel, 0);
100
  }
101
}
102
103
#endif /* defined(AMIROLLD_CFG_USE_PKLCS1212E4001) */
104 5e2f673b Marc Rothmann
105
/** @} */