magneto13.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef MAGNETO13_H
#define MAGNETO13_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define MAGNETO13_REG_ZERO_0                0x00
#define MAGNETO13_REG_ZERO_1                0x01
#define MAGNETO13_REG_BCT                   0x02
#define MAGNETO13_REG_ET_YX                 0x03
#define MAGNETO13_REG_MG_LT_HT_MG           0x06
#define MAGNETO13_REG_IRQM_RAR_HYST         0x07
#define MAGNETO13_REG_THR                   0x08
#define MAGNETO13_REG_RD                    0x09
#define MAGNETO13_REG_REF                   0x0A
#define MAGNETO13_REG_TRISTATE_SPI_PULL     0x0D
#define MAGNETO13_REG_FW                    0x0E
#define MAGNETO13_REG_ERR_PAR_MEM_NVM       0x1A
#define MAGNETO13_REG_M_GH_GL               0x1B
 
 // magneto13_reg
 
#define MAGNETO13_CMD_READ_ANGLE            0x00
#define MAGNETO13_CMD_CLEAR_ERR_FLAGS       0x01
#define MAGNETO13_CMD_READ_REGISTER         0x02
#define MAGNETO13_CMD_WRITE_REGISTER        0x04
#define MAGNETO13_CMD_RESTORE_ALL_NVM       0x05
#define MAGNETO13_CMD_STORE_ALL_NVM         0x06
#define MAGNETO13_CMD_STORE_SINGLE_NVM      0x07
 
 // magneto13_cmd
 
#define MAGNETO13_CMD_BIT_MASK              0x07
#define MAGNETO13_REG_BIT_MASK              0x1F
 
#define MAGNETO13_TRIMMING_X_DIS            0x00
#define MAGNETO13_TRIMMING_X_EN             0x01
#define MAGNETO13_TRIMMING_Y_DIS            0x00
#define MAGNETO13_TRIMMING_Y_EN             0x02
 
#define MAGNETO13_MG_LT_LVL_0               0x00
#define MAGNETO13_MG_LT_LVL_1               0x40
#define MAGNETO13_MG_LT_LVL_2               0x80
#define MAGNETO13_MG_LT_LVL_3               0xC0
#define MAGNETO13_MG_HT_LVL_0               0x00
#define MAGNETO13_MG_HT_LVL_1               0x10
#define MAGNETO13_MG_HT_LVL_2               0x20
#define MAGNETO13_MG_HT_LVL_3               0x30
#define MAGNETO13_MG_BIT_MASK               0xF0
#define MAGNETO13_MG_FLD_THD_DIS            0x00
#define MAGNETO13_MG_FLD_THD_EN             0x01
 
#define MAGNETO13_FLD_ST_OK                 0x00
#define MAGNETO13_FLD_ST_MGL                0x01
#define MAGNETO13_FLD_ST_MGH                0x02
#define MAGNETO13_FLD_ST_BIT_MASK           0x03
 
#define MAGNETO13_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define MAGNETO13_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // magneto13_set
 
#define MAGNETO13_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.err = MIKROBUS( mikrobus, MIKROBUS_AN );    \
    cfg.nvm = MIKROBUS( mikrobus, MIKROBUS_PWM );   \
    cfg.irq = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // magneto13_map
 // magneto13
 
typedef struct
{
    // Input pins
    digital_in_t err;    
    digital_in_t nvm;    
    digital_in_t irq;    
    // Modules
    spi_master_t spi;            
    pin_name_t   chip_select;    
} magneto13_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    // Additional gpio pins
    pin_name_t  err;    
    pin_name_t nvm;     
    pin_name_t irq;     
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} magneto13_cfg_t;
 
typedef enum
{
    MAGNETO13_OK = 0,
    MAGNETO13_ERROR = -1
 
} magneto13_return_value_t;
 
void magneto13_cfg_setup ( magneto13_cfg_t *cfg );
 
err_t magneto13_init ( magneto13_t *ctx, magneto13_cfg_t *cfg );
 
err_t magneto13_default_cfg ( magneto13_t *ctx );
 
err_t magneto13_write_reg ( magneto13_t *ctx, uint8_t cmd, uint8_t reg, uint8_t data_in );
 
err_t magneto13_read_reg ( magneto13_t *ctx, uint8_t cmd, uint8_t reg, uint8_t *data_out );
 
err_t magneto13_get_angle_raw_data ( magneto13_t *ctx, uint16_t *raw_data );
 
err_t magneto13_get_angle ( magneto13_t *ctx, float *angle );
 
err_t magneto13_set_mag_field_thd ( magneto13_t *ctx, uint8_t mglt, uint8_t mght );
 
err_t magneto13_enable_fld_thd_det ( magneto13_t *ctx );
 
err_t magneto13_get_field_strength ( magneto13_t *ctx, uint8_t *field_strength );
 
uint8_t magneto13_get_error_flag ( magneto13_t *ctx );
 
uint8_t magneto13_get_nvm_access_state ( magneto13_t *ctx );
 
uint8_t magneto13_get_interrupt ( magneto13_t *ctx );
 
 
 
#ifdef __cplusplus
}
#endif
#endif // MAGNETO13_H
 
 // magneto13
 
// ------------------------------------------------------------------------ END