Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / PKxxxExxx / v1 / alld_PKxxxExxx_v1.h @ 119ec0d2

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

    
27
#ifndef AMIROLLD_PKXXXEXXX_V1_H
28
#define AMIROLLD_PKXXXEXXX_V1_H
29

    
30
#include <amiro-lld.h>
31

    
32
#if (defined(AMIROLLD_CFG_PKxxxExxx) && (AMIROLLD_CFG_PKxxxExxx == 1)) || defined(__DOXYGEN__)
33

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

    
38
/******************************************************************************/
39
/* SETTINGS                                                                   */
40
/******************************************************************************/
41

    
42
/******************************************************************************/
43
/* CHECKS                                                                     */
44
/******************************************************************************/
45

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

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

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

    
64
/******************************************************************************/
65
/* DATA STRUCTURES AND TYPES                                                  */
66
/******************************************************************************/
67

    
68
/******************************************************************************/
69
/* MACROS                                                                     */
70
/******************************************************************************/
71

    
72
/******************************************************************************/
73
/* EXTERN DECLARATIONS                                                        */
74
/******************************************************************************/
75

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

    
85
/******************************************************************************/
86
/* INLINE FUNCTIONS                                                           */
87
/******************************************************************************/
88

    
89
#endif /* defined(AMIROLLD_CFG_PKxxxExxx) && (AMIROLLD_CFG_PKxxxExxx == 1) */
90

    
91
#endif /* AMIROLLD_PKXXXEXXX_V1_H */
92

    
93
/** @} */