gyro8.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 GYRO8_H
#define GYRO8_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 GYRO8_REG_RATE                  0x01
#define GYRO8_REG_TEMP                  0x07
#define GYRO8_REG_RATE_STATUS_1         0x09
#define GYRO8_REG_RATE_STATUS_2         0x0A
#define GYRO8_REG_ACC_STATUS            0x0F
#define GYRO8_REG_TEST                  0x15
#define GYRO8_REG_RESET_CONTROL         0x16
#define GYRO8_REG_SERIAL_ID0            0x18
#define GYRO8_REG_SERIAL_ID1            0x19
#define GYRO8_REG_COMMON_STATUS         0x1B
#define GYRO8_REG_ID                    0x1D
#define GYRO8_REG_STATUS_SUMMARY        0x1F
 
 // gyro8_reg
 
#define GYRO8_ID                        0x0500
 
#define GYRO8_TEMP_SENS                 14.7f
#define GYRO8_TEMP_OFFSET               60.0f
#define GYRO8_GYRO_SENS                 50.0f
 
#define GYRO8_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define GYRO8_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // gyro8_set
 
#define GYRO8_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.rst  = MIKROBUS( mikrobus, MIKROBUS_RST );
#define GYRO8_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // gyro8_map
 // gyro8
 
typedef struct
{
    // Output pins
    digital_out_t rst;              
    // Modules
    spi_master_t  spi;              
    pin_name_t    chip_select;      
} gyro8_t;
typedef struct {…};
 
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 rst;                 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} gyro8_cfg_t;
typedef struct {…};
 
typedef enum
{
    GYRO8_OK = 0,
    GYRO8_ERROR = -1
 
} gyro8_return_value_t;
typedef enum {…};
 
void gyro8_cfg_setup ( gyro8_cfg_t *cfg );
 
err_t gyro8_init ( gyro8_t *ctx, gyro8_cfg_t *cfg );
 
err_t gyro8_default_cfg ( gyro8_t *ctx );
 
err_t gyro8_write_register ( gyro8_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t gyro8_read_register ( gyro8_t *ctx, uint8_t reg, uint16_t *data_out );
 
void gyro8_set_rst_pin ( gyro8_t *ctx, uint8_t state );
 
void gyro8_reset_device ( gyro8_t *ctx );
 
err_t gyro8_check_communication ( gyro8_t *ctx );
 
err_t gyro8_read_serial_id ( gyro8_t *ctx, uint32_t *serial_id );
 
err_t gyro8_read_temperature ( gyro8_t *ctx, float *temperature );
 
err_t gyro8_read_angular_rate ( gyro8_t *ctx, float *rate );
 
#ifdef __cplusplus
}
#endif
#endif // GYRO8_H
 
 // gyro8
 
// ------------------------------------------------------------------------ END