gyro4.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 GYRO4_H
#define GYRO4_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 GYRO4_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.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define GYRO4_RETVAL  uint8_t
 
#define GYRO4_OK           0x00
#define GYRO4_INIT_ERROR   0xFF
#define GYRO4_REG_WHO_AM_I         0x00
#define GYRO4_REG_TEMP_OUT_L       0x01
#define GYRO4_REG_TEMP_OUT_H       0x02
#define GYRO4_REG_OUT_X_L          0x03
#define GYRO4_REG_OUT_X_H          0x04
#define GYRO4_REG_OUT_Y_L          0x05
#define GYRO4_REG_OUT_Y_H          0x06
#define GYRO4_REG_DATA_STATUS_OIS  0x0A
#define GYRO4_REG_CTRL1_OIS        0x0B
#define GYRO4_REG_CTRL2_OIS        0x0C
#define GYRO4_REG_CTRL3_OIS        0x0D
#define GYRO4_REG_CTRL4_OIS        0x0E
#define GYRO4_REG_OFF_X            0x0F
#define GYRO4_REG_OFF_Y            0x10
#define GYRO4_REG_OIS_CFG          0x1F
#define GYRO4_POWER_DOWN_MODE  0x01
#define GYRO4_SLEEP_MODE       0x02
#define GYRO4_NORMAL_MODE      0x03
#define GYRO4_100_DPS  0x01
#define GYRO4_200_DPS  0x02
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{  
    // Output pins 
 
    digital_out_t cs;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
    uint8_t aux_buffer [ 6 ];
 
} gyro4_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 int_pin;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} gyro4_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void gyro4_cfg_setup ( gyro4_cfg_t *cfg );
 
GYRO4_RETVAL gyro4_init ( gyro4_t *ctx, gyro4_cfg_t *cfg );
 
void gyro4_generic_transfer ( gyro4_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf,  uint16_t rd_len );
 
uint8_t gyro4_int_get( gyro4_t *ctx );
 
void gyro4_cs_set( gyro4_t *ctx, uint8_t pin_state );
 
uint8_t gyro4_spi_get ( gyro4_t *ctx, uint8_t register_address, uint8_t * register_buffer, uint16_t n_registers );
 
uint8_t gyro4_spi_set ( gyro4_t *ctx, uint8_t register_address, uint8_t data_in );
 
uint8_t gyro4_initialize ( gyro4_t *ctx );
 
uint8_t gyro4_get_temperature ( gyro4_t *ctx, float * temperature );
 
uint8_t gyro4_get_axes( gyro4_t *ctx, float * x_axis, float * y_axis );
 
uint8_t gyro4_software_reset ( gyro4_t *ctx );
 
uint8_t gyro4_set_power_mode ( gyro4_t *ctx, uint8_t power_mode );
 
uint8_t gyro4_set_full_scale_range( gyro4_t *ctx, uint8_t full_scale_range );
 
#ifdef __cplusplus
}
#endif
#endif  // _GYRO4_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END