magneticrotary2.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 MAGNETICROTARY2_H
#define MAGNETICROTARY2_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 MAGNETICROTARY2_REG_CUST_RES_0              0x00
#define MAGNETICROTARY2_REG_CUST_RES_1              0x01
#define MAGNETICROTARY2_REG_CUST_RES_2              0x02
#define MAGNETICROTARY2_REG_CUST_RES_3              0x03
#define MAGNETICROTARY2_REG_CUST_RES_4              0x04
#define MAGNETICROTARY2_REG_CUST_RES_5              0x05
#define MAGNETICROTARY2_REG_CUST_RES_6              0x06
#define MAGNETICROTARY2_REG_CUST_CONFIG_0_MSB       0x07
#define MAGNETICROTARY2_REG_CUST_CONFIG_0_LSB       0x08
#define MAGNETICROTARY2_REG_CUST_CONFIG_1_MSB       0x09
#define MAGNETICROTARY2_REG_CUST_CONFIG_1_LSB       0x0A
#define MAGNETICROTARY2_REG_CUST_CONFIG_2           0x0B
#define MAGNETICROTARY2_REG_ZERO_RESET_2            0x0C
#define MAGNETICROTARY2_REG_ZERO_RESET_1            0x0D
#define MAGNETICROTARY2_REG_ZERO_RESET_0            0x0E
#define MAGNETICROTARY2_REG_UNLOCK                  0x10
#define MAGNETICROTARY2_REG_PROGRAM                 0x11
#define MAGNETICROTARY2_REG_CALIBRATION             0x12
#define MAGNETICROTARY2_REG_ERROR_BITS              0x21
#define MAGNETICROTARY2_REG_CALIBRATION_STAT        0x22
#define MAGNETICROTARY2_REG_POSITION                0x3F
 
 // magneticrotary2_reg
 
#define MAGNETICROTARY2_UNLOCK_VALUE                0xAB
#define MAGNETICROTARY2_LOCK_VALUE                  0xFF
#define MAGNETICROTARY2_PROGRAM_VALUE               0xA1
 
#define MAGNETICROTARY2_ODD_PARITY                  0x01
 
#define MAGNETICROTARY2_MSEL1_READ_BIT              0x40
#define MAGNETICROTARY2_MSEL0_WRITE_BIT             0x80
 
#define MAGNETICROTARY2_CC0_MSB_HW_ST_ZERO_EN       0x80
#define MAGNETICROTARY2_CC0_MSB_HW_ACC_CALIB_EN     0x40
#define MAGNETICROTARY2_CC0_MSB_AXIS_MODE_OFF       0x20
#define MAGNETICROTARY2_CC0_MSB_IWIDTH_90           0x00
#define MAGNETICROTARY2_CC0_MSB_IWIDTH_180          0x04
#define MAGNETICROTARY2_CC0_MSB_IWIDTH_270          0x08
#define MAGNETICROTARY2_CC0_MSB_IWIDTH_360          0x0C
#define MAGNETICROTARY2_CC0_MSB_IPHASE_90           0x00
#define MAGNETICROTARY2_CC0_MSB_IPHASE_180          0x01
#define MAGNETICROTARY2_CC0_MSB_IPHASE_270          0x02
#define MAGNETICROTARY2_CC0_MSB_IPHASE_360          0x03
#define MAGNETICROTARY2_CC0_LSB_HYST_0_00           0x00
#define MAGNETICROTARY2_CC0_LSB_HYST_0_01           0x20
#define MAGNETICROTARY2_CC0_LSB_HYST_0_02           0x40
#define MAGNETICROTARY2_CC0_LSB_HYST_0_04           0x60
#define MAGNETICROTARY2_CC0_LSB_HYST_0_08           0x80
#define MAGNETICROTARY2_CC0_LSB_HYST_0_17           0xA0
#define MAGNETICROTARY2_CC0_LSB_HYST_0_35           0xC0
#define MAGNETICROTARY2_CC0_LSB_HYST_0_70           0xE0
#define MAGNETICROTARY2_CC0_LSB_DIR_CCW             0x10
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_18BIT       0x00
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_17BIT       0x01
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_16BIT       0x02
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_15BIT       0x03
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_14BIT       0x04
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_13BIT       0x05
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_12BIT       0x06
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_11BIT       0x07
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_10BIT       0x08
#define MAGNETICROTARY2_CC0_LSB_ABS_RES_MASK        0x0F
 
#define MAGNETICROTARY2_SET_DATA_SAMPLE_EDGE        SET_SPI_DATA_SAMPLE_EDGE
#define MAGNETICROTARY2_SET_DATA_SAMPLE_MIDDLE      SET_SPI_DATA_SAMPLE_MIDDLE
 
 // magneticrotary2_set
 
typedef enum
{
    MAGNETICROTARY2_MSEL_0,      
    MAGNETICROTARY2_MSEL_1       
} magneticrotary2_msel_t;
 
#define MAGNETICROTARY2_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 )
 
 // magneticrotary2_map
 // magneticrotary2
 
typedef struct
{
    // Output pins
    digital_out_t ssi_sel;          
    // Modules
    spi_master_t  spi;              
    pin_name_t  chip_select;        
    magneticrotary2_msel_t msel;    
    uint8_t abs_res;                
} magneticrotary2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                                   
    pin_name_t  mosi;                                   
    pin_name_t  sck;                                    
    pin_name_t  cs;                                     
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
    magneticrotary2_msel_t             msel;            
} magneticrotary2_cfg_t;
 
typedef enum
{
    MAGNETICROTARY2_OK = 0,
    MAGNETICROTARY2_ERROR = -1
 
} magneticrotary2_return_value_t;
 
void magneticrotary2_cfg_setup ( magneticrotary2_cfg_t *cfg );
 
void magneticrotary2_msel_pin_selection ( magneticrotary2_cfg_t *cfg, magneticrotary2_msel_t msel );
 
err_t magneticrotary2_init ( magneticrotary2_t *ctx, magneticrotary2_cfg_t *cfg );
 
err_t magneticrotary2_default_cfg ( magneticrotary2_t *ctx );
 
err_t magneticrotary2_write_register ( magneticrotary2_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t magneticrotary2_read_register ( magneticrotary2_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t magneticrotary2_unlock_eeprom ( magneticrotary2_t *ctx );
 
err_t magneticrotary2_lock_eeprom ( magneticrotary2_t *ctx );
 
err_t magneticrotary2_program_eeprom ( magneticrotary2_t *ctx );
 
err_t magneticrotary2_get_raw_data ( magneticrotary2_t *ctx, uint32_t *data_out );
 
err_t magneticrotary2_get_angle ( magneticrotary2_t *ctx, float *angle );
 
#ifdef __cplusplus
}
#endif
#endif // MAGNETICROTARY2_H
 
 // magneticrotary2
 
// ------------------------------------------------------------------------ END