terminal  2.0.0.0
terminal.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef TERMINAL_H
36 #define TERMINAL_H
37 
38 #include "drv_digital_out.h"
39 
40 // -------------------------------------------------------------- PUBLIC MACROS
50 #define TERMINAL_MAP_MIKROBUS( cfg, mikrobus ) \
51  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
52  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
53  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
54  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
55  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ); \
56  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
57  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
58  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
59  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
60  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
61  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
62  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_TX )
63 
69 #define TERMINAL_RETVAL uint8_t
70 
71 #define TERMINAL_OK 0x00
72 #define TERMINAL_INIT_ERROR 0xFF
73  // End group macro
76 // --------------------------------------------------------------- PUBLIC TYPES
85 typedef struct
86 {
87  // Communication pins
88 
89  digital_out_t scl;
90  digital_out_t sda;
91  digital_out_t sck;
92  digital_out_t miso;
93  digital_out_t mosi;
94  digital_out_t cs;
95  digital_out_t tx_pin;
96  digital_out_t rx_pin;
97 
98  // Gpio pins
99 
100  digital_out_t an;
101  digital_out_t rst;
102  digital_out_t pwm;
103  digital_out_t int_pin;
104 
105 } terminal_t;
106 
110 typedef struct
111 {
112  // Communication pins
113 
114  pin_name_t scl;
115  pin_name_t sda;
116  pin_name_t sck;
117  pin_name_t miso;
118  pin_name_t mosi;
119  pin_name_t cs;
120  pin_name_t tx_pin;
121  pin_name_t rx_pin;
122 
123  // Gpio pins
124 
125  pin_name_t an;
126  pin_name_t rst;
127  pin_name_t pwm;
128  pin_name_t int_pin;
129 
131  // End types group
133 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
134 
140 #ifdef __cplusplus
141 extern "C"{
142 #endif
143 
152 void terminal_cfg_setup ( terminal_cfg_t *cfg );
153 
162 
172 void terminal_set_pin_high ( digital_out_t *pin );
173 
183 void terminal_set_pin_low ( digital_out_t *pin );
184 
185 #ifdef __cplusplus
186 }
187 #endif
188 #endif // _TERMINAL_H_
189  // End public_function group
192 
193 // ------------------------------------------------------------------------- END
digital_out_t cs
Definition: terminal.h:94
pin_name_t sck
Definition: terminal.h:116
pin_name_t cs
Definition: terminal.h:119
void terminal_cfg_setup(terminal_cfg_t *cfg)
Config Object Initialization function.
digital_out_t sck
Definition: terminal.h:91
digital_out_t miso
Definition: terminal.h:92
digital_out_t an
Definition: terminal.h:100
pin_name_t rx_pin
Definition: terminal.h:121
digital_out_t rx_pin
Definition: terminal.h:96
pin_name_t pwm
Definition: terminal.h:127
pin_name_t miso
Definition: terminal.h:117
void terminal_set_pin_high(digital_out_t *pin)
Set pin high function.
TERMINAL_RETVAL terminal_init(terminal_t *ctx, terminal_cfg_t *cfg)
Initialization function.
pin_name_t an
Definition: terminal.h:125
pin_name_t sda
Definition: terminal.h:115
pin_name_t mosi
Definition: terminal.h:118
void terminal_set_pin_low(digital_out_t *pin)
Set pin low function.
digital_out_t scl
Definition: terminal.h:89
digital_out_t int_pin
Definition: terminal.h:103
pin_name_t tx_pin
Definition: terminal.h:120
digital_out_t rst
Definition: terminal.h:101
Click ctx object definition.
Definition: terminal.h:85
pin_name_t scl
Definition: terminal.h:114
digital_out_t sda
Definition: terminal.h:90
digital_out_t mosi
Definition: terminal.h:93
Click configuration structure definition.
Definition: terminal.h:110
pin_name_t int_pin
Definition: terminal.h:128
digital_out_t tx_pin
Definition: terminal.h:95
#define TERMINAL_RETVAL
Definition: terminal.h:69
digital_out_t pwm
Definition: terminal.h:102
pin_name_t rst
Definition: terminal.h:126