angle5.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 ANGLE5_H
#define ANGLE5_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define ANGLE5_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.mgh   = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
   cfg.mgl   = MIKROBUS( mikrobus, MIKROBUS_INT )
#define ANGLE5_RETVAL  uint8_t
 
#define ANGLE5_OK                           0x00
#define ANGLE5_INIT_ERROR                   0xFF
#define ANGLE5_REG_ZERO_SETTING_LSB         0x00
#define ANGLE5_REG_ZERO_SETTING_MSB         0x01
#define ANGLE5_REG_BIAS_CURRENT_TRIMMING    0x02
#define ANGLE5_REG_ENABLE_TRIMMING_XY       0x03
#define ANGLE5_REG_CONFIG_1                 0x04
#define ANGLE5_REG_CONFIG_2                 0x05
#define ANGLE5_REG_MAGNETIC_FIELD_THR       0x06
#define ANGLE5_REG_NUMBER_OF_POLE_PAIRS     0x07
#define ANGLE5_REG_ROTATION_DIRECTION       0x09
#define ANGLE5_REG_MG_H_L                   0x1B
#define ANGLE5_CMD_READ_ANGLE               0x00
#define ANGLE5_CMD_READ                     0x40
#define ANGLE5_CMD_WRITE                    0x80
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t cs;
 
    // Input pins 
 
    digital_in_t mgh;
    digital_in_t mgl;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} angle5_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 mgh;
    pin_name_t mgl;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} angle5_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void angle5_cfg_setup ( angle5_cfg_t *cfg );
 
ANGLE5_RETVAL angle5_init ( angle5_t *ctx, angle5_cfg_t *cfg );
 
void angle5_default_cfg ( angle5_t *ctx );
 
void angle5_generic_transfer 
( 
    angle5_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len, 
    uint8_t *rd_buf, 
    uint16_t rd_len 
);
 
uint16_t angle5_read_raw_angle ( angle5_t *ctx );
 
float angle5_read_angle_deg ( angle5_t *ctx );
 
uint16_t angle5_read_register ( angle5_t *ctx, uint8_t reg_addr, uint8_t *rsp );
 
uint16_t angle5_write_register ( angle5_t *ctx, uint8_t reg_addr, uint8_t tx_data, uint8_t *status );
 
float angle5_calc_rpm ( float old_angle, float new_angle );
 
uint8_t angle5_get_mgh_pin_state( angle5_t *ctx );
 
uint8_t angle5_get_mgl_pin_state( angle5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _ANGLE5_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END