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 "drv_spi_master.h"
39
40// -------------------------------------------------------------- PUBLIC MACROS
51#define LINHALL_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
53 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
54 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
55 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
56
63#define LINHALL_RETVAL uint8_t
64
65#define LINHALL_OK 0x00
66#define LINHALL_INIT_ERROR 0xFF // End group macro
70// --------------------------------------------------------------- PUBLIC TYPES
79typedef struct
80{
81 digital_out_t cs;
82
83 // Modules
84
85 spi_master_t spi;
86 pin_name_t chip_select;
87
88} linhall_t;
89
93typedef struct
94{
95 // Communication gpio pins
96
97 pin_name_t miso;
98 pin_name_t mosi;
99 pin_name_t sck;
100 pin_name_t cs;
101
102 // static variable
103
104 uint32_t spi_speed;
105 spi_master_mode_t spi_mode;
106 spi_master_chip_select_polarity_t cs_polarity;
107
109 // End types group
111// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
112
117#ifdef __cplusplus
118extern "C"{
119#endif
120
130
140
153(
154 linhall_t *ctx,
155 uint8_t *wr_buf,
156 uint16_t wr_len,
157 uint8_t *rd_buf,
158 uint16_t rd_len
159);
160
171uint16_t linhall_read_data ( linhall_t *ctx );
172#ifdef __cplusplus
173}
174#endif
175#endif // _LINHALL_H_
176 // End public_function group
179
180// ------------------------------------------------------------------------- END
#define LINHALL_RETVAL
Definition: linhall.h:63
void linhall_cfg_setup(linhall_cfg_t *cfg)
Config Object Initialization function.
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.
uint16_t linhall_read_data(linhall_t *ctx)
Read 12-bit data function.
LINHALL_RETVAL linhall_init(linhall_t *ctx, linhall_cfg_t *cfg)
Initialization function.
Click configuration structure definition.
Definition: linhall.h:94
spi_master_chip_select_polarity_t cs_polarity
Definition: linhall.h:106
pin_name_t sck
Definition: linhall.h:99
spi_master_mode_t spi_mode
Definition: linhall.h:105
pin_name_t mosi
Definition: linhall.h:98
uint32_t spi_speed
Definition: linhall.h:104
pin_name_t miso
Definition: linhall.h:97
pin_name_t cs
Definition: linhall.h:100
Click ctx object definition.
Definition: linhall.h:80
digital_out_t cs
Definition: linhall.h:81
spi_master_t spi
Definition: linhall.h:85
pin_name_t chip_select
Definition: linhall.h:86