-
Notifications
You must be signed in to change notification settings - Fork 38
/
hal_ll_gpio_port.h
148 lines (131 loc) · 4.47 KB
/
hal_ll_gpio_port.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/****************************************************************************
**
** Copyright (C) ${COPYRIGHT_YEAR} MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
/*!
* @file hal_ll_gpio.h
* @brief This file contains all the functions prototypes for the GPIO library.
*/
#ifndef _HAL_LL_GPIO_PORT_H_
#define _HAL_LL_GPIO_PORT_H_
#ifdef __cplusplus
extern "C"{
#endif
#include "hal_ll_target.h"
#include "hal_ll_gpio_constants.h"
/**
* GPIO module registers access structure
*/
typedef struct {
hal_ll_base_addr_t port_reg_addr;
hal_ll_base_addr_t ddr_reg_addr;
hal_ll_base_addr_t pin_reg_addr;
} hal_ll_gpio_base_handle_t;
/**
* Handle and mask types.
*/
typedef handle_t hal_ll_gpio_base_t;
/**
* Enum used for pin direction selection.
*/
typedef enum {
HAL_LL_GPIO_DIGITAL_INPUT = 0,
HAL_LL_GPIO_DIGITAL_OUTPUT = 1
} hal_ll_gpio_direction_t;
/**
* Enum used for pin direction selection.
*/
typedef struct hal_ll_gpio_t {
hal_ll_gpio_base_t base;
hal_ll_gpio_mask_t mask;
};
/**
* Pin and port data types.
*/
typedef struct hal_ll_gpio_t hal_ll_gpio_pin_t;
typedef struct hal_ll_gpio_t hal_ll_gpio_port_t;
/**
* @brief Get pins port index within a list of available ports
* @param name - desired pin
* @return uint8_t value from 0 to PORT_COUNT-1
*/
uint8_t hal_ll_gpio_port_index(hal_ll_pin_name_t name);
/**
* @brief Get pin mask of provided pin within proprietery port
* @param name - desired pin
* @return uint8_t
*/
uint8_t hal_ll_gpio_port_pin_mask(hal_ll_pin_name_t name);
/**
* @brief Get address of port register offsets map
* @param name - desired port
* @return uint16_t address of first regsiter
*/
uint16_t hal_ll_gpio_port_base_map(hal_ll_port_name_t name);
/**
* @brief Set pin as analog input
* @param port - port base address acquired from hal_gpio_ll_port_base
* @param pin_mask - pin mask acquired from hal_gpio_ll_pin_mask
* @return none
*/
void hal_ll_gpio_port_analog_input(uint16_t *port, uint8_t pin_mask);
/**
* @brief Set port as analog input
* @param port - port base address acquired from hal_gpio_ll_port_base
* @param name - port index value
* @return none
*/
void hal_ll_gpio_port_digital_configure_port(hal_ll_gpio_port_t *port, uint8_t name, bool is_input);
/**
* @brief Set pin as digital input
* @param port - port base address acquired from hal_gpio_ll_port_base
* @param pin_mask - pin mask acquired from hal_gpio_ll_pin_mask
* @return none
*/
void hal_ll_gpio_port_digital_input(uint16_t *port, uint8_t pin_mask);
/**
* @brief Set pin as digital output
* @param port - port base address acquired from hal_gpio_ll_port_base
* @param pin_mask - pin mask acquired from hal_gpio_ll_pin_mask
* @return none
*/
void hal_ll_gpio_port_digital_output(uint16_t *port, uint8_t pin);
#ifdef __cplusplus
}
#endif
#endif // _HAL_LL_GPIO_PORT_H_
// ------------------------------------------------------------------------- END