Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / alld_pklcs1212e4001.c @ 21076167

History | View | Annotate | Download (4.02 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_pklcs1212e4001.c
21
 * @brief   Buzzer function implementations.
22
 *
23
 * @addtogroup lld_buzzer
24
 * @{
25
 */
26

    
27
#include <alld_pklcs1212e4001.h>
28

    
29
#if defined(AMIROLLD_CFG_USE_PKLCS1212E4001) || defined(__DOXYGEN__)
30

    
31
/******************************************************************************/
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
/**
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
apalExitStatus_t pklcs1212e4001_lld_checkPWMconfiguration(apalPWMDriver_t* pwm)
61
{
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
  if (frequency / period == PKLCS1212E4001_LLD_FREQUENCY_SPEC) {
69
    status |= APAL_STATUS_OK;
70
  } else if (frequency / period >= PKLCS1212E4001_LLD_FREQUENCY_MIN &&
71
             frequency / period <= PKLCS1212E4001_LLD_FREQUENCY_MAX) {
72
    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
apalExitStatus_t pklcs1212e4001_lld_enable(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const bool enable)
88
{
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
#endif /* defined(AMIROLLD_CFG_USE_PKLCS1212E4001) */
102

    
103
/** @} */