Statistics
| Branch: | Tag: | Revision:

amiro-lld / drivers / MIC9404x / v1 / alld_MIC9404x.h @ 9466e34d

History | View | Annotate | Download (3.49 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_MIC9404x.h
21
 * @brief   MIC9404x power switch macros and structures.
22
 *
23
 * @addtogroup lld_powerswitch
24
 * @{
25
 */
26

    
27
#ifndef AMIROLLD_MIC9404x_H
28
#define AMIROLLD_MIC9404x_H
29

    
30
#include <amiro-lld.h>
31

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

    
36
/**
37
 * @brief Active state of EN GPIO (active high).
38
 */
39
#define MIC9404x_LLD_EN_ACTIVE_STATE            APAL_GPIO_ACTIVE_HIGH
40

    
41
/******************************************************************************/
42
/* SETTINGS                                                                   */
43
/******************************************************************************/
44

    
45
/******************************************************************************/
46
/* CHECKS                                                                     */
47
/******************************************************************************/
48

    
49
/******************************************************************************/
50
/* DATA STRUCTURES AND TYPES                                                  */
51
/******************************************************************************/
52

    
53
/**
54
 * @brief MIC9404x driver data structure.
55
 */
56
typedef struct {
57
  const apalControlGpio_t* en;  /**< @brief The identifier of the EN GPIO.  */
58
} MIC9404xDriver;
59

    
60
/**
61
 * @brief The state of the MIC9404x.
62
 */
63
typedef enum {
64
  MIC9404x_LLD_STATE_OFF = 0x00,   /**< 'on' state of the MIC9404x */
65
  MIC9404x_LLD_STATE_ON  = 0x01,   /**< 'off' state of the MIC9404x */
66
} mic9404x_lld_state_t;
67

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

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

    
76
#ifdef __cplusplus
77
extern "C" {
78
#endif
79
  apalExitStatus_t mic9404x_lld_set(const MIC9404xDriver* const mic9404x, const mic9404x_lld_state_t state);
80
  apalExitStatus_t mic9404x_lld_get(const MIC9404xDriver* const mic9404x, mic9404x_lld_state_t* const state);
81
#ifdef __cplusplus
82
}
83
#endif
84

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

    
89
#endif /* AMIROLLD_MIC9404x_H */
90

    
91
/** @} */
92