linhall  2.0.0.0
linhall.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 LINHALL_H
36 #define LINHALL_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_spi_master.h"
49 
50 // -------------------------------------------------------------- PUBLIC MACROS
61 #define LINHALL_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
63  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
64  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
65  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
66 
73 #define LINHALL_RETVAL uint8_t
74 
75 #define LINHALL_OK 0x00
76 #define LINHALL_INIT_ERROR 0xFF
77  // End group macro
80 // --------------------------------------------------------------- PUBLIC TYPES
89 typedef struct
90 {
91  digital_out_t cs;
92 
93  // Modules
94 
95  spi_master_t spi;
96  pin_name_t chip_select;
97 
98 } linhall_t;
99 
103 typedef struct
104 {
105  // Communication gpio pins
106 
107  pin_name_t miso;
108  pin_name_t mosi;
109  pin_name_t sck;
110  pin_name_t cs;
111 
112  // static variable
113 
114  uint32_t spi_speed;
115  spi_master_mode_t spi_mode;
116  spi_master_chip_select_polarity_t cs_polarity;
117 
118 } linhall_cfg_t;
119  // End types group
121 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
122 
127 #ifdef __cplusplus
128 extern "C"{
129 #endif
130 
140 
150 
163 (
164  linhall_t *ctx,
165  uint8_t *wr_buf,
166  uint16_t wr_len,
167  uint8_t *rd_buf,
168  uint16_t rd_len
169 );
170 
181 uint16_t linhall_read_data ( linhall_t *ctx );
182 #ifdef __cplusplus
183 }
184 #endif
185 #endif // _LINHALL_H_
186  // End public_function group
189 
190 // ------------------------------------------------------------------------- END
linhall_cfg_t
Click configuration structure definition.
Definition: linhall.h:104
linhall_t::spi
spi_master_t spi
Definition: linhall.h:95
linhall_cfg_t::cs
pin_name_t cs
Definition: linhall.h:110
linhall_t::chip_select
pin_name_t chip_select
Definition: linhall.h:96
linhall_cfg_t::miso
pin_name_t miso
Definition: linhall.h:107
linhall_t::cs
digital_out_t cs
Definition: linhall.h:91
linhall_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: linhall.h:116
linhall_t
Click ctx object definition.
Definition: linhall.h:90
LINHALL_RETVAL
#define LINHALL_RETVAL
Definition: linhall.h:73
linhall_cfg_setup
void linhall_cfg_setup(linhall_cfg_t *cfg)
Config Object Initialization function.
linhall_init
LINHALL_RETVAL linhall_init(linhall_t *ctx, linhall_cfg_t *cfg)
Initialization function.
linhall_cfg_t::mosi
pin_name_t mosi
Definition: linhall.h:108
linhall_cfg_t::spi_speed
uint32_t spi_speed
Definition: linhall.h:114
linhall_generic_transfer
void linhall_generic_transfer(linhall_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
linhall_cfg_t::sck
pin_name_t sck
Definition: linhall.h:109
linhall_read_data
uint16_t linhall_read_data(linhall_t *ctx)
Read 12-bit data function.
linhall_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: linhall.h:115