shuttle  2.0.0.0
shuttle.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 SHUTTLE_H
36 #define SHUTTLE_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 
50 // -------------------------------------------------------------- PUBLIC MACROS
60 #define SHUTTLE_MAP_MIKROBUS( cfg, mikrobus ) \
61  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
62  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
63  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
64  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
65  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ); \
66  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
67  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
68  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
69  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
70  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
71  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
72  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_TX )
73 
79 #define SHUTTLE_RETVAL uint8_t
80 
81 #define SHUTTLE_OK 0x00
82 #define SHUTTLE_INIT_ERROR 0xFF
83  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
95 typedef struct
96 {
97  // Communication pins
98 
99  digital_out_t scl;
100  digital_out_t sda;
101  digital_out_t sck;
102  digital_out_t miso;
103  digital_out_t mosi;
104  digital_out_t cs;
105  digital_out_t tx_pin;
106  digital_out_t rx_pin;
107 
108  // Gpio pins
109 
110  digital_out_t an;
111  digital_out_t rst;
112  digital_out_t pwm;
113  digital_out_t int_pin;
114 
115 } shuttle_t;
116 
120 typedef struct
121 {
122  // Communication pins
123 
124  pin_name_t scl;
125  pin_name_t sda;
126  pin_name_t sck;
127  pin_name_t miso;
128  pin_name_t mosi;
129  pin_name_t cs;
130  pin_name_t tx_pin;
131  pin_name_t rx_pin;
132 
133  // Gpio pins
134 
135  pin_name_t an;
136  pin_name_t rst;
137  pin_name_t pwm;
138  pin_name_t int_pin;
139 
140 } shuttle_cfg_t;
141  // End types group
143 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
144 
150 #ifdef __cplusplus
151 extern "C"{
152 #endif
153 
163 
172 
182 void shuttle_set_pin_high ( digital_out_t *pin );
183 
193 void shuttle_set_pin_low ( digital_out_t *pin );
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 #endif // _SHUTTLE_H_
199  // End public_function group
202 
203 // ------------------------------------------------------------------------- END
shuttle_t::an
digital_out_t an
Definition: shuttle.h:110
shuttle_cfg_t
Click configuration structure definition.
Definition: shuttle.h:121
shuttle_cfg_t::scl
pin_name_t scl
Definition: shuttle.h:124
shuttle_cfg_t::mosi
pin_name_t mosi
Definition: shuttle.h:128
shuttle_t::mosi
digital_out_t mosi
Definition: shuttle.h:103
shuttle_t::scl
digital_out_t scl
Definition: shuttle.h:99
shuttle_t::cs
digital_out_t cs
Definition: shuttle.h:104
shuttle_t::rst
digital_out_t rst
Definition: shuttle.h:111
shuttle_t::int_pin
digital_out_t int_pin
Definition: shuttle.h:113
shuttle_t::sda
digital_out_t sda
Definition: shuttle.h:100
SHUTTLE_RETVAL
#define SHUTTLE_RETVAL
Definition: shuttle.h:79
shuttle_t::sck
digital_out_t sck
Definition: shuttle.h:101
shuttle_cfg_t::rst
pin_name_t rst
Definition: shuttle.h:136
shuttle_init
SHUTTLE_RETVAL shuttle_init(shuttle_t *ctx, shuttle_cfg_t *cfg)
Initialization function.
shuttle_cfg_t::int_pin
pin_name_t int_pin
Definition: shuttle.h:138
shuttle_t
Click ctx object definition.
Definition: shuttle.h:96
shuttle_cfg_setup
void shuttle_cfg_setup(shuttle_cfg_t *cfg)
Config Object Initialization function.
shuttle_cfg_t::rx_pin
pin_name_t rx_pin
Definition: shuttle.h:131
shuttle_cfg_t::cs
pin_name_t cs
Definition: shuttle.h:129
shuttle_set_pin_high
void shuttle_set_pin_high(digital_out_t *pin)
Set pin high function.
shuttle_t::tx_pin
digital_out_t tx_pin
Definition: shuttle.h:105
shuttle_cfg_t::sck
pin_name_t sck
Definition: shuttle.h:126
shuttle_cfg_t::an
pin_name_t an
Definition: shuttle.h:135
shuttle_t::rx_pin
digital_out_t rx_pin
Definition: shuttle.h:106
shuttle_cfg_t::pwm
pin_name_t pwm
Definition: shuttle.h:137
shuttle_cfg_t::miso
pin_name_t miso
Definition: shuttle.h:127
shuttle_cfg_t::tx_pin
pin_name_t tx_pin
Definition: shuttle.h:130
shuttle_cfg_t::sda
pin_name_t sda
Definition: shuttle.h:125
shuttle_t::miso
digital_out_t miso
Definition: shuttle.h:102
shuttle_set_pin_low
void shuttle_set_pin_low(digital_out_t *pin)
Set pin low function.
shuttle_t::pwm
digital_out_t pwm
Definition: shuttle.h:112