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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_spi_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
68 #define MAGNETO2_MAP_MIKROBUS( cfg, mikrobus ) \
69  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
70  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
71  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
72  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
73 
79 #define MAGNETO2_RETVAL uint8_t
80 
81 #define MAGNETO2_OK 0x00
82 #define MAGNETO2_INIT_ERROR 0xFF
83  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
95 typedef struct
96 {
97  digital_out_t cs;
98 
99  // Modules
100 
101  spi_master_t spi;
102  pin_name_t chip_select;
103 
104 } magneto2_t;
105 
109 typedef struct
110 {
111  // Communication gpio pins
112 
113  pin_name_t miso;
114  pin_name_t mosi;
115  pin_name_t sck;
116  pin_name_t cs;
117 
118  // static variable
119 
120  uint32_t spi_speed;
121  uint8_t spi_mode;
122  spi_master_chip_select_polarity_t cs_polarity;
123 
125  // End types group
127 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
128 
133 #ifdef __cplusplus
134 extern "C"{
135 #endif
136 
146 
156 
157 
169 
179 uint16_t magneto2_read_data ( magneto2_t* ctx );
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 #endif // _MAGNETO2_H_
185  // End public_function group
188 
189 // ------------------------------------------------------------------------- END
magneto2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: magneto2.h:122
magneto2_cfg_t::sck
pin_name_t sck
Definition: magneto2.h:115
magneto2_cfg_t::mosi
pin_name_t mosi
Definition: magneto2.h:114
magneto2_cfg_t::cs
pin_name_t cs
Definition: magneto2.h:116
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:120
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:79
magneto2_t::chip_select
pin_name_t chip_select
Definition: magneto2.h:102
magneto2_cfg_t::spi_mode
uint8_t spi_mode
Definition: magneto2.h:121
magneto2_t::cs
digital_out_t cs
Definition: magneto2.h:97
magneto2_cfg_t
Click configuration structure definition.
Definition: magneto2.h:110
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:113
magneto2_t::spi
spi_master_t spi
Definition: magneto2.h:101
magneto2_t
Click ctx object definition.
Definition: magneto2.h:96
magneto2_init
MAGNETO2_RETVAL magneto2_init(magneto2_t *ctx, magneto2_cfg_t *cfg)
Initialization function.