gmrangle  2.0.0.0
gmrangle.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 GMRANGLE_H
36 #define GMRANGLE_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 #include "spi_specifics.h"
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
68 #define GMRANGLE_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  cfg.ifa = MIKROBUS( mikrobus, MIKROBUS_AN ); \
74  cfg.css = MIKROBUS( mikrobus, MIKROBUS_RST ); \
75  cfg.ifc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
76  cfg.ifb = MIKROBUS( mikrobus, MIKROBUS_INT )
77 
83 #define GMRANGLE_OK 0
84 #define GMRANGLE_ERROR -1
85 
91 #define GMRANGLE_REG_STAT 0x00
92 #define GMRANGLE_REG_ACSTAT 0x01
93 #define GMRANGLE_REG_AVAL 0x02
94 #define GMRANGLE_REG_ASPD 0x03
95 #define GMRANGLE_REG_AREV 0x04
96 #define GMRANGLE_REG_FSYNC 0x05
97 #define GMRANGLE_REG_MOD_1 0x06
98 #define GMRANGLE_REG_SIL 0x07
99 #define GMRANGLE_REG_MOD_2 0x08
100 #define GMRANGLE_REG_MOD_3 0x09
101 #define GMRANGLE_REG_OFFX 0x0A
102 #define GMRANGLE_REG_OFFY 0x0B
103 #define GMRANGLE_REG_SYNCH 0x0C
104 #define GMRANGLE_REG_IFAB 0x0D
105 #define GMRANGLE_REG_MOD_4 0x0E
106 #define GMRANGLE_REG_TCO_Y 0x0F
107 #define GMRANGLE_REG_ADC_X 0x10
108 #define GMRANGLE_REG_ADC_Y 0x11
109 
115 #define GMRANGLE_READ_SENSOR 0x80
116 #define GMRANGLE_GET_BIT_5_4 0x30
117 #define GMRANGLE_GET_BIT_3_0 0x0F
118 
124 #define GMRANGLE_SYSTEM_ERROR_MASK 0x4000
125 #define GMRANGLE_INTERFACE_ERROR_MASK 0x2000
126 #define GMRANGLE_INV_ANGLE_ERROR_MASK 0x1000
127 #define GMRANGLE_CRC_POLYNOMIAL 0x1D00
128 #define GMRANGLE_CRC_SEED 0xFF00
129 #define GMRANGLE_CRC_NUM_REGISTERS 0x0008
130 #define GMRANGLE_MAX_REGISTER_MEM 0x0030
131 #define GMRANGLE_DELETE_BIT_15 0x7FFF
132 #define GMRANGLE_CHANGE_UINT_TO_INT_16 0xFFFF
133 #define GMRANGLE_CHANGE_UINT_TO_INT_15 0x8000
134 #define GMRANGLE_MAX_BIT_14 0x3FFF
135 #define GMRANGLE_CHECK_BIT_14 0x4000
136 #define GMRANGLE_GET_BIT_14_4 0x7FF0
137 #define GMRANGLE_DELETE_7BITS 0x01FF
138 #define GMRANGLE_CHANGE_UNIT_TO_INT_9 0x0200
139 #define GMRANGLE_CHECK_BIT_9 0x0100
140 #define GMRANGLE_CHECK_BIT_15 0x8000
141 
147 #define GMRANGLE_POW_2_15 32768.0f
148 #define GMRANGLE_POW_2_7 128.0f
149 #define GMRANGLE_ANGLE_360_VAL 360.0f
150 #define GMRANGLE_TEMP_OFFSET 152.0f
151 #define GMRANGLE_TEMP_DIV 2.776f
152 #define GMRANGLE_DATA_RESOLUTION 0x7FFF
153 
163 #define GMRANGLE_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
164 #define GMRANGLE_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
165  // End group macro
167 // --------------------------------------------------------------- PUBLIC TYPES
176 typedef struct
177 {
178  // Output pins
179  digital_out_t cs;
180  digital_out_t css;
181 
182  // Input pins
183  digital_in_t ifa;
184  digital_in_t ifb;
185  digital_in_t ifc;
186 
187  // Modules
188  spi_master_t spi;
189  pin_name_t chip_select;
190 
191 } gmrangle_t;
192 
196 typedef struct
197 {
198  // Communication gpio pins
199  pin_name_t miso;
200  pin_name_t mosi;
201  pin_name_t sck;
202  pin_name_t cs;
203 
204  // Additional gpio pins
205  pin_name_t ifa;
206  pin_name_t css;
207  pin_name_t ifc;
208  pin_name_t ifb;
209 
210  // static variable
211  uint32_t spi_speed;
212  spi_master_mode_t spi_mode;
213  spi_master_chip_select_polarity_t cs_polarity;
214 
216  // End types group
218 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
219 
224 #ifdef __cplusplus
225 extern "C"{
226 #endif
227 
237 
247 
260 uint16_t gmrangle_read_data ( gmrangle_t *ctx, uint8_t reg );
261 
273 void gmrangle_write_data ( gmrangle_t *ctx, uint8_t reg, uint16_t tx_data );
274 
328 uint16_t gmrangle_get_status ( gmrangle_t *ctx );
329 
366 void gmrangle_set_act_status ( gmrangle_t *ctx, uint16_t a_data );
367 
380 
392 void gmrangle_get_angle_speed ( gmrangle_t *ctx, float *final_angle_speed, int16_t *angle_speed_val );
393 
406 
419 
432 
445 
446 #ifdef __cplusplus
447 }
448 #endif
449 #endif // _GMRANGLE_H_
450  // End public_function group
453 
454 // ------------------------------------------------------------------------- END
gmrangle_cfg_t::sck
pin_name_t sck
Definition: gmrangle.h:201
gmrangle_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: gmrangle.h:213
gmrangle_cfg_t::spi_speed
uint32_t spi_speed
Definition: gmrangle.h:211
gmrangle_get_angle_value
uint16_t gmrangle_get_angle_value(gmrangle_t *ctx)
Get the angle value function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
gmrangle_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gmrangle.h:212
gmrangle_write_data
void gmrangle_write_data(gmrangle_t *ctx, uint8_t reg, uint16_t tx_data)
Generic write 16-bit data function.
gmrangle_cfg_t::miso
pin_name_t miso
Definition: gmrangle.h:199
gmrangle_set_act_status
void gmrangle_set_act_status(gmrangle_t *ctx, uint16_t a_data)
Set activation status register function.
gmrangle_cfg_t::mosi
pin_name_t mosi
Definition: gmrangle.h:200
gmrangle_cfg_t::ifc
pin_name_t ifc
Definition: gmrangle.h:207
gmrangle_get_num_revolutions
int16_t gmrangle_get_num_revolutions(gmrangle_t *ctx)
Get the number of revolutions function.
gmrangle_read_data
uint16_t gmrangle_read_data(gmrangle_t *ctx, uint8_t reg)
Generic read 16-bit data function.
gmrangle_t::cs
digital_out_t cs
Definition: gmrangle.h:179
gmrangle_get_angle_speed_value
int16_t gmrangle_get_angle_speed_value(gmrangle_t *ctx)
Get the angle speed value function.
gmrangle_t::css
digital_out_t css
Definition: gmrangle.h:180
gmrangle_t::ifa
digital_in_t ifa
Definition: gmrangle.h:183
gmrangle_t::ifc
digital_in_t ifc
Definition: gmrangle.h:185
gmrangle_t::spi
spi_master_t spi
Definition: gmrangle.h:188
gmrangle_cfg_t::cs
pin_name_t cs
Definition: gmrangle.h:202
gmrangle_init
err_t gmrangle_init(gmrangle_t *ctx, gmrangle_cfg_t *cfg)
Initialization function.
gmrangle_cfg_t::ifa
pin_name_t ifa
Definition: gmrangle.h:205
gmrangle_t::chip_select
pin_name_t chip_select
Definition: gmrangle.h:189
gmrangle_get_angle_range
float gmrangle_get_angle_range(gmrangle_t *ctx)
Get the angle range function.
gmrangle_get_status
uint16_t gmrangle_get_status(gmrangle_t *ctx)
Get the status data function.
gmrangle_cfg_setup
void gmrangle_cfg_setup(gmrangle_cfg_t *cfg)
Config Object Initialization function.
gmrangle_cfg_t
Click configuration structure definition.
Definition: gmrangle.h:197
gmrangle_t::ifb
digital_in_t ifb
Definition: gmrangle.h:184
gmrangle_get_angle_speed
void gmrangle_get_angle_speed(gmrangle_t *ctx, float *final_angle_speed, int16_t *angle_speed_val)
Get the angle speed function.
gmrangle_cfg_t::css
pin_name_t css
Definition: gmrangle.h:206
gmrangle_t
Click ctx object definition.
Definition: gmrangle.h:177
gmrangle_cfg_t::ifb
pin_name_t ifb
Definition: gmrangle.h:208
gmrangle_calculate_angle
float gmrangle_calculate_angle(gmrangle_t *ctx)
Calculate angle function.