magneto14  2.1.0.0
magneto14.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef MAGNETO14_H
29 #define MAGNETO14_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_spi_master.h"
52 #include "spi_specifics.h"
53 
74 #define MAGNETO14_REG_ZERO_0 0x00
75 #define MAGNETO14_REG_ZERO_1 0x01
76 #define MAGNETO14_REG_BCT 0x02
77 #define MAGNETO14_REG_ET_YX 0x03
78 #define MAGNETO14_REG_PPT_ILIP 0x04
79 #define MAGNETO14_REG_PPT 0x05
80 #define MAGNETO14_REG_MG_LT_HT_MG 0x06
81 #define MAGNETO14_REG_RD 0x09
82 #define MAGNETO14_REG_FW 0x0E
83 #define MAGNETO14_REG_HYS 0x10
84 #define MAGNETO14_REG_M_GH_GL 0x1B
85  // magneto14_reg
87 
97 #define MAGNETO14_CMD_READ_ANGLE 0x00
98 #define MAGNETO14_CMD_READ_REGISTER 0x02
99 #define MAGNETO14_CMD_WRITE_REGISTER 0x04
100 #define MAGNETO14_CMD_RESTORE_ALL_NVM 0x05
101 #define MAGNETO14_CMD_STORE_ALL_NVM 0x06
102 #define MAGNETO14_CMD_STORE_SINGLE_NVM 0x07
103  // magneto14_cmd
105 
120 #define MAGNETO14_CMD_BIT_MASK 0x07
121 #define MAGNETO14_REG_BIT_MASK 0x1F
122 
127 #define MAGNETO14_TRIMMING_X_DIS 0x00
128 #define MAGNETO14_TRIMMING_X_EN 0x01
129 #define MAGNETO14_TRIMMING_Y_DIS 0x00
130 #define MAGNETO14_TRIMMING_Y_EN 0x02
131 
136 #define MAGNETO14_MG_LT_LVL_0 0x00
137 #define MAGNETO14_MG_LT_LVL_1 0x20
138 #define MAGNETO14_MG_LT_LVL_2 0x40
139 #define MAGNETO14_MG_LT_LVL_3 0x60
140 #define MAGNETO14_MG_LT_LVL_4 0x80
141 #define MAGNETO14_MG_LT_LVL_5 0xA0
142 #define MAGNETO14_MG_LT_LVL_6 0xC0
143 #define MAGNETO14_MG_LT_LVL_7 0xE0
144 #define MAGNETO14_MG_HT_LVL_0 0x00
145 #define MAGNETO14_MG_HT_LVL_1 0x04
146 #define MAGNETO14_MG_HT_LVL_2 0x08
147 #define MAGNETO14_MG_HT_LVL_3 0x0C
148 #define MAGNETO14_MG_HT_LVL_4 0x10
149 #define MAGNETO14_MG_HT_LVL_5 0x14
150 #define MAGNETO14_MG_HT_LVL_6 0x18
151 #define MAGNETO14_MG_HT_LVL_7 0x1C
152 #define MAGNETO14_MG_BIT_MASK 0xFC
153 
158 #define MAGNETO14_MGH_ST_OK 0x00
159 #define MAGNETO14_FLD_ST_OK 0x00
160 #define MAGNETO14_FLD_ST_MGL 0x01
161 #define MAGNETO14_FLD_ST_MGH 0x02
162 #define MAGNETO14_FLD_ST_BIT_MASK 0x03
163 
172 #define MAGNETO14_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
173 #define MAGNETO14_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
174  // magneto14_set
176 
191 #define MAGNETO14_MAP_MIKROBUS( cfg, mikrobus ) \
192  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
193  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
194  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
195  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
196  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
197  cfg.mgh = MIKROBUS( mikrobus, MIKROBUS_INT )
198  // magneto14_map // magneto14
201 
206 typedef struct
207 {
208  // Output pins
209  digital_out_t pwm;
211  // Input pins
212  digital_in_t mgh;
214  // Modules
215  spi_master_t spi;
217  pin_name_t chip_select;
219 } magneto14_t;
220 
225 typedef struct
226 {
227  // Communication gpio pins
228  pin_name_t miso;
229  pin_name_t mosi;
230  pin_name_t sck;
231  pin_name_t cs;
233  // Additional gpio pins
234  pin_name_t pwm;
235  pin_name_t mgh;
237  // static variable
238  uint32_t spi_speed;
239  spi_master_mode_t spi_mode;
240  spi_master_chip_select_polarity_t cs_polarity;
243 
248 typedef enum
249 {
251  MAGNETO14_ERROR = -1
252 
254 
271 
286 
300 
315 err_t magneto14_write_reg ( magneto14_t *ctx, uint8_t cmd, uint8_t reg, uint8_t data_in );
316 
331 err_t magneto14_read_reg ( magneto14_t *ctx, uint8_t cmd, uint8_t reg, uint8_t *data_out );
332 
346 err_t magneto14_get_angle_raw_data ( magneto14_t *ctx, uint16_t *raw_data );
347 
361 err_t magneto14_get_angle ( magneto14_t *ctx, float *angle );
362 
377 err_t magneto14_set_mag_field_thd ( magneto14_t *ctx, uint8_t mglt, uint8_t mght );
378 
395 err_t magneto14_get_field_strength ( magneto14_t *ctx, uint8_t *field_strength );
396 
408 void magneto14_set_pwm_pin ( magneto14_t *ctx, uint8_t pwm_state );
409 
423 
424 #ifdef __cplusplus
425 }
426 #endif
427 #endif // MAGNETO14_H
428  // magneto14
430 
431 // ------------------------------------------------------------------------ END
magneto14_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: magneto14.h:239
magneto14_return_value_t
magneto14_return_value_t
Magneto 14 Click return value data.
Definition: magneto14.h:249
MAGNETO14_ERROR
@ MAGNETO14_ERROR
Definition: magneto14.h:251
magneto14_t::chip_select
pin_name_t chip_select
Definition: magneto14.h:217
magneto14_cfg_t::cs
pin_name_t cs
Definition: magneto14.h:231
magneto14_write_reg
err_t magneto14_write_reg(magneto14_t *ctx, uint8_t cmd, uint8_t reg, uint8_t data_in)
Magneto 14 data writing function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
magneto14_t
Magneto 14 Click context object.
Definition: magneto14.h:207
magneto14_cfg_setup
void magneto14_cfg_setup(magneto14_cfg_t *cfg)
Magneto 14 configuration object setup function.
magneto14_read_reg
err_t magneto14_read_reg(magneto14_t *ctx, uint8_t cmd, uint8_t reg, uint8_t *data_out)
Magneto 14 data reading function.
magneto14_cfg_t::mgh
pin_name_t mgh
Definition: magneto14.h:235
magneto14_cfg_t::sck
pin_name_t sck
Definition: magneto14.h:230
MAGNETO14_OK
@ MAGNETO14_OK
Definition: magneto14.h:250
magneto14_get_angle
err_t magneto14_get_angle(magneto14_t *ctx, float *angle)
Magneto 14 gets the angular position function.
magneto14_init
err_t magneto14_init(magneto14_t *ctx, magneto14_cfg_t *cfg)
Magneto 14 initialization function.
magneto14_get_angle_raw_data
err_t magneto14_get_angle_raw_data(magneto14_t *ctx, uint16_t *raw_data)
Magneto 14 gets the angle raw data function.
magneto14_cfg_t::mosi
pin_name_t mosi
Definition: magneto14.h:229
magneto14_set_pwm_pin
void magneto14_set_pwm_pin(magneto14_t *ctx, uint8_t pwm_state)
Magneto 14 set PWM pin function.
magneto14_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: magneto14.h:240
magneto14_default_cfg
err_t magneto14_default_cfg(magneto14_t *ctx)
Magneto 14 default configuration function.
magneto14_get_mgh
uint8_t magneto14_get_mgh(magneto14_t *ctx)
Magneto 14 gets the MGH function.
magneto14_cfg_t
Magneto 14 Click configuration object.
Definition: magneto14.h:226
magneto14_t::mgh
digital_in_t mgh
Definition: magneto14.h:212
magneto14_cfg_t::miso
pin_name_t miso
Definition: magneto14.h:228
magneto14_set_mag_field_thd
err_t magneto14_set_mag_field_thd(magneto14_t *ctx, uint8_t mglt, uint8_t mght)
Magneto 14 sets the magnetic field threshold function.
magneto14_cfg_t::spi_speed
uint32_t spi_speed
Definition: magneto14.h:238
magneto14_t::pwm
digital_out_t pwm
Definition: magneto14.h:209
magneto14_cfg_t::pwm
pin_name_t pwm
Definition: magneto14.h:234
magneto14_t::spi
spi_master_t spi
Definition: magneto14.h:215
magneto14_get_field_strength
err_t magneto14_get_field_strength(magneto14_t *ctx, uint8_t *field_strength)
Magneto 14 gets the magnetic field strength function.