magneto2  2.0.0.0
magneto2.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 MAGNETO2_H
36 #define MAGNETO2_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 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define MAGNETO2_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
66  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
67  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
68  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
69 
75 #define MAGNETO2_RETVAL uint8_t
76 
77 #define MAGNETO2_OK 0x00
78 #define MAGNETO2_INIT_ERROR 0xFF
79  // End group macro
82 // --------------------------------------------------------------- PUBLIC TYPES
91 typedef struct
92 {
93  digital_out_t cs;
94 
95  // Modules
96 
97  spi_master_t spi;
98  pin_name_t chip_select;
99 
100 } magneto2_t;
101 
105 typedef struct
106 {
107  // Communication gpio pins
108 
109  pin_name_t miso;
110  pin_name_t mosi;
111  pin_name_t sck;
112  pin_name_t cs;
113 
114  // static variable
115 
116  uint32_t spi_speed;
117  uint8_t spi_mode;
118  spi_master_chip_select_polarity_t cs_polarity;
119 
121  // End types group
123 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
124 
129 #ifdef __cplusplus
130 extern "C"{
131 #endif
132 
142 
152 
153 
165 
175 uint16_t magneto2_read_data ( magneto2_t* ctx );
176 
177 #ifdef __cplusplus
178 }
179 #endif
180 #endif // _MAGNETO2_H_
181  // End public_function group
184 
185 // ------------------------------------------------------------------------- END
magneto2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: magneto2.h:118
magneto2_cfg_t::sck
pin_name_t sck
Definition: magneto2.h:111
magneto2_cfg_t::mosi
pin_name_t mosi
Definition: magneto2.h:110
magneto2_cfg_t::cs
pin_name_t cs
Definition: magneto2.h:112
magneto2_cfg_setup
void magneto2_cfg_setup(magneto2_cfg_t *cfg)
Config Object Initialization function.
magneto2_cfg_t::spi_speed
uint32_t spi_speed
Definition: magneto2.h:116
magneto2_read_data
uint16_t magneto2_read_data(magneto2_t *ctx)
Generic read two bytes command function.
MAGNETO2_RETVAL
#define MAGNETO2_RETVAL
Definition: magneto2.h:75
magneto2_t::chip_select
pin_name_t chip_select
Definition: magneto2.h:98
magneto2_cfg_t::spi_mode
uint8_t spi_mode
Definition: magneto2.h:117
magneto2_t::cs
digital_out_t cs
Definition: magneto2.h:93
magneto2_cfg_t
Click configuration structure definition.
Definition: magneto2.h:106
magneto2_read_angle
float magneto2_read_angle(magneto2_t *ctx)
Generic read angle function.
magneto2_cfg_t::miso
pin_name_t miso
Definition: magneto2.h:109
magneto2_t::spi
spi_master_t spi
Definition: magneto2.h:97
magneto2_t
Click ctx object definition.
Definition: magneto2.h:92
magneto2_init
MAGNETO2_RETVAL magneto2_init(magneto2_t *ctx, magneto2_cfg_t *cfg)
Initialization function.