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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define MAGNETO2_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
59 
65 #define MAGNETO2_RETVAL uint8_t
66 
67 #define MAGNETO2_OK 0x00
68 #define MAGNETO2_INIT_ERROR 0xFF
69  // End group macro
72 // --------------------------------------------------------------- PUBLIC TYPES
81 typedef struct
82 {
83  digital_out_t cs;
84 
85  // Modules
86 
87  spi_master_t spi;
88  pin_name_t chip_select;
89 
90 } magneto2_t;
91 
95 typedef struct
96 {
97  // Communication gpio pins
98 
99  pin_name_t miso;
100  pin_name_t mosi;
101  pin_name_t sck;
102  pin_name_t cs;
103 
104  // static variable
105 
106  uint32_t spi_speed;
107  uint8_t spi_mode;
108  spi_master_chip_select_polarity_t cs_polarity;
109 
111  // End types group
113 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
114 
119 #ifdef __cplusplus
120 extern "C"{
121 #endif
122 
132 
142 
143 
155 
165 uint16_t magneto2_read_data ( magneto2_t* ctx );
166 
167 #ifdef __cplusplus
168 }
169 #endif
170 #endif // _MAGNETO2_H_
171  // End public_function group
174 
175 // ------------------------------------------------------------------------- END
magneto2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: magneto2.h:108
magneto2_cfg_t::sck
pin_name_t sck
Definition: magneto2.h:101
magneto2_cfg_t::mosi
pin_name_t mosi
Definition: magneto2.h:100
magneto2_cfg_t::cs
pin_name_t cs
Definition: magneto2.h:102
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:106
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:65
magneto2_t::chip_select
pin_name_t chip_select
Definition: magneto2.h:88
magneto2_cfg_t::spi_mode
uint8_t spi_mode
Definition: magneto2.h:107
magneto2_t::cs
digital_out_t cs
Definition: magneto2.h:83
magneto2_cfg_t
Click configuration structure definition.
Definition: magneto2.h:96
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:99
magneto2_t::spi
spi_master_t spi
Definition: magneto2.h:87
magneto2_t
Click ctx object definition.
Definition: magneto2.h:82
magneto2_init
MAGNETO2_RETVAL magneto2_init(magneto2_t *ctx, magneto2_cfg_t *cfg)
Initialization function.