Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / alld_pklcs1212e4001.h @ ef078306

History | View | Annotate | Download (3.42 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.h
21
 * @brief   Buzzer macros.
22
 *
23
 * @addtogroup lld_buzzer
24
 * @{
25
 */
26

    
27
#ifndef AMIROLLD_PKLCS1212E4001_H
28
#define AMIROLLD_PKLCS1212E4001_H
29

    
30
#include <amiro-lld.h>
31

    
32
#if defined(AMIROLLD_CFG_USE_PKLCS1212E4001) || defined(__DOXYGEN__)
33

    
34
/******************************************************************************/
35
/* CONSTANTS                                                                  */
36
/******************************************************************************/
37

    
38
/**
39
 * @brief   Specified frequency of the PKLCS1212E4001.
40
 */
41
#define PKLCS1212E4001_LLD_FREQUENCY_SPEC       4000
42

    
43
/**
44
 * @brief   Minimum frequency for the buzzer to sound.
45
 */
46
#define PKLCS1212E4001_LLD_FREQUENCY_MIN        2000
47

    
48
/**
49
 * @brief   Maximum frequency for the buzzer to sound.
50
 */
51
#define PKLCS1212E4001_LLD_FREQUENCY_MAX        6000
52

    
53
/******************************************************************************/
54
/* SETTINGS                                                                   */
55
/******************************************************************************/
56

    
57
/******************************************************************************/
58
/* CHECKS                                                                     */
59
/******************************************************************************/
60

    
61
/******************************************************************************/
62
/* DATA STRUCTURES AND TYPES                                                  */
63
/******************************************************************************/
64

    
65
/******************************************************************************/
66
/* MACROS                                                                     */
67
/******************************************************************************/
68

    
69
/******************************************************************************/
70
/* EXTERN DECLARATIONS                                                        */
71
/******************************************************************************/
72

    
73
#ifdef __cplusplus
74
extern "C" {
75
#endif
76
  apalExitStatus_t pklcs1212e4001_lld_checkPWMconfiguration(apalPWMDriver_t* pwm);
77
  apalExitStatus_t pklcs1212e4001_lld_enable(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const bool enable);
78
#ifdef __cplusplus
79
}
80
#endif
81

    
82
/******************************************************************************/
83
/* INLINE FUNCTIONS                                                           */
84
/******************************************************************************/
85

    
86
#endif /* defined(AMIROLLD_CFG_USE_PKLCS1212E4001) */
87

    
88
#endif /* AMIROLLD_PKLCS1212E4001_H */
89

    
90
/** @} */