Statistics
| Branch: | Tag: | Revision:

amiro-lld / drivers / PKxxxExxx / v1 / alld_PKxxxExxx.h @ ed9a1bf5

History | View | Annotate | Download (3.527 KB)

1
/*
2
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
3
Copyright (C) 2016..2020  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_PKxxxExxx.h
21
 * @brief   Buzzer macros.
22
 *
23
 * @addtogroup lld_buzzer
24
 * @{
25
 */
26

    
27
#ifndef AMIROLLD_PKXXXEXXX_H
28
#define AMIROLLD_PKXXXEXXX_H
29

    
30
#include <amiro-lld.h>
31

    
32
/******************************************************************************/
33
/* CONSTANTS                                                                  */
34
/******************************************************************************/
35

    
36
/******************************************************************************/
37
/* SETTINGS                                                                   */
38
/******************************************************************************/
39

    
40
/******************************************************************************/
41
/* CHECKS                                                                     */
42
/******************************************************************************/
43

    
44
#ifndef PKxxxExxx_LLD_FREQUENCY_SPEC
45
        #error "PKxxxExxx_LLD_FREQUENCY_SPEC not defined"
46
#elif !(PKxxxExxx_LLD_FREQUENCY_SPEC > 0)
47
        #error "PKxxxExxx_LLD_FREQUENCY_SPEC set to invalid value"
48
#endif
49

    
50
#ifndef PKxxxExxx_LLD_FREQUENCY_MIN
51
        #warning "PKxxxExxx_LLD_FREQUENCY_MIN not defined (recommended)"
52
#elif !(PKxxxExxx_LLD_FREQUENCY_MIN > 0)
53
        #error "PKxxxExxx_LLD_FREQUENCY_MIN set to invalid value"
54
#endif
55

    
56
#ifndef PKxxxExxx_LLD_FREQUENCY_MAX
57
        #warning "PKxxxExxx_LLD_FREQUENCY_MAX not defined (recommended)"
58
#elif !(PKxxxExxx_LLD_FREQUENCY_MAX > 0)
59
        #error "PKxxxExxx_LLD_FREQUENCY_MAX set to invalid value"
60
#endif
61

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

    
66
/******************************************************************************/
67
/* MACROS                                                                     */
68
/******************************************************************************/
69

    
70
/******************************************************************************/
71
/* EXTERN DECLARATIONS                                                        */
72
/******************************************************************************/
73

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

    
83
/******************************************************************************/
84
/* INLINE FUNCTIONS                                                           */
85
/******************************************************************************/
86

    
87
#endif /* AMIROLLD_PKXXXEXXX_H */
88

    
89
/** @} */
90