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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define MAGNETO14_REG_ZERO_0 0x00
61 #define MAGNETO14_REG_ZERO_1 0x01
62 #define MAGNETO14_REG_BCT 0x02
63 #define MAGNETO14_REG_ET_YX 0x03
64 #define MAGNETO14_REG_PPT_ILIP 0x04
65 #define MAGNETO14_REG_PPT 0x05
66 #define MAGNETO14_REG_MG_LT_HT_MG 0x06
67 #define MAGNETO14_REG_RD 0x09
68 #define MAGNETO14_REG_FW 0x0E
69 #define MAGNETO14_REG_HYS 0x10
70 #define MAGNETO14_REG_M_GH_GL 0x1B
71  // magneto14_reg
73 
83 #define MAGNETO14_CMD_READ_ANGLE 0x00
84 #define MAGNETO14_CMD_READ_REGISTER 0x02
85 #define MAGNETO14_CMD_WRITE_REGISTER 0x04
86 #define MAGNETO14_CMD_RESTORE_ALL_NVM 0x05
87 #define MAGNETO14_CMD_STORE_ALL_NVM 0x06
88 #define MAGNETO14_CMD_STORE_SINGLE_NVM 0x07
89  // magneto14_cmd
91 
106 #define MAGNETO14_CMD_BIT_MASK 0x07
107 #define MAGNETO14_REG_BIT_MASK 0x1F
108 
113 #define MAGNETO14_TRIMMING_X_DIS 0x00
114 #define MAGNETO14_TRIMMING_X_EN 0x01
115 #define MAGNETO14_TRIMMING_Y_DIS 0x00
116 #define MAGNETO14_TRIMMING_Y_EN 0x02
117 
122 #define MAGNETO14_MG_LT_LVL_0 0x00
123 #define MAGNETO14_MG_LT_LVL_1 0x20
124 #define MAGNETO14_MG_LT_LVL_2 0x40
125 #define MAGNETO14_MG_LT_LVL_3 0x60
126 #define MAGNETO14_MG_LT_LVL_4 0x80
127 #define MAGNETO14_MG_LT_LVL_5 0xA0
128 #define MAGNETO14_MG_LT_LVL_6 0xC0
129 #define MAGNETO14_MG_LT_LVL_7 0xE0
130 #define MAGNETO14_MG_HT_LVL_0 0x00
131 #define MAGNETO14_MG_HT_LVL_1 0x04
132 #define MAGNETO14_MG_HT_LVL_2 0x08
133 #define MAGNETO14_MG_HT_LVL_3 0x0C
134 #define MAGNETO14_MG_HT_LVL_4 0x10
135 #define MAGNETO14_MG_HT_LVL_5 0x14
136 #define MAGNETO14_MG_HT_LVL_6 0x18
137 #define MAGNETO14_MG_HT_LVL_7 0x1C
138 #define MAGNETO14_MG_BIT_MASK 0xFC
139 
144 #define MAGNETO14_MGH_ST_OK 0x00
145 #define MAGNETO14_FLD_ST_OK 0x00
146 #define MAGNETO14_FLD_ST_MGL 0x01
147 #define MAGNETO14_FLD_ST_MGH 0x02
148 #define MAGNETO14_FLD_ST_BIT_MASK 0x03
149 
158 #define MAGNETO14_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
159 #define MAGNETO14_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
160  // magneto14_set
162 
177 #define MAGNETO14_MAP_MIKROBUS( cfg, mikrobus ) \
178  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
179  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
180  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
181  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
182  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
183  cfg.mgh = MIKROBUS( mikrobus, MIKROBUS_INT )
184  // magneto14_map // magneto14
187 
192 typedef struct
193 {
194  // Output pins
195  digital_out_t pwm;
197  // Input pins
198  digital_in_t mgh;
200  // Modules
201  spi_master_t spi;
203  pin_name_t chip_select;
205 } magneto14_t;
206 
211 typedef struct
212 {
213  // Communication gpio pins
214  pin_name_t miso;
215  pin_name_t mosi;
216  pin_name_t sck;
217  pin_name_t cs;
219  // Additional gpio pins
220  pin_name_t pwm;
221  pin_name_t mgh;
223  // static variable
224  uint32_t spi_speed;
225  spi_master_mode_t spi_mode;
226  spi_master_chip_select_polarity_t cs_polarity;
229 
234 typedef enum
235 {
237  MAGNETO14_ERROR = -1
238 
240 
257 
272 
286 
301 err_t magneto14_write_reg ( magneto14_t *ctx, uint8_t cmd, uint8_t reg, uint8_t data_in );
302 
317 err_t magneto14_read_reg ( magneto14_t *ctx, uint8_t cmd, uint8_t reg, uint8_t *data_out );
318 
332 err_t magneto14_get_angle_raw_data ( magneto14_t *ctx, uint16_t *raw_data );
333 
347 err_t magneto14_get_angle ( magneto14_t *ctx, float *angle );
348 
363 err_t magneto14_set_mag_field_thd ( magneto14_t *ctx, uint8_t mglt, uint8_t mght );
364 
381 err_t magneto14_get_field_strength ( magneto14_t *ctx, uint8_t *field_strength );
382 
394 void magneto14_set_pwm_pin ( magneto14_t *ctx, uint8_t pwm_state );
395 
409 
410 #ifdef __cplusplus
411 }
412 #endif
413 #endif // MAGNETO14_H
414  // magneto14
416 
417 // ------------------------------------------------------------------------ END
magneto14_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: magneto14.h:225
magneto14_return_value_t
magneto14_return_value_t
Magneto 14 Click return value data.
Definition: magneto14.h:235
MAGNETO14_ERROR
@ MAGNETO14_ERROR
Definition: magneto14.h:237
magneto14_t::chip_select
pin_name_t chip_select
Definition: magneto14.h:203
magneto14_cfg_t::cs
pin_name_t cs
Definition: magneto14.h:217
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:193
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:221
magneto14_cfg_t::sck
pin_name_t sck
Definition: magneto14.h:216
MAGNETO14_OK
@ MAGNETO14_OK
Definition: magneto14.h:236
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:215
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:226
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:212
magneto14_t::mgh
digital_in_t mgh
Definition: magneto14.h:198
magneto14_cfg_t::miso
pin_name_t miso
Definition: magneto14.h:214
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:224
magneto14_t::pwm
digital_out_t pwm
Definition: magneto14.h:195
magneto14_cfg_t::pwm
pin_name_t pwm
Definition: magneto14.h:220
magneto14_t::spi
spi_master_t spi
Definition: magneto14.h:201
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.