sundp
/
STM32CubeWL
mirror of https://github.com/STMicroelectronics/STM32CubeWL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
STM32CubeWL/Drivers/BSP/Components/stts22h/stts22h_reg.h

358 lines
9.1 KiB
C
Raw Blame History

/**
******************************************************************************
* @file stts22h_reg.h
* @author Sensors Software Solution Team
* @brief This file contains all the functions prototypes for the
* stts22h_reg.c driver.
******************************************************************************
* @attention
*
* Copyright (c) 2019 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef STTS22H_REGS_H
#define STTS22H_REGS_H
#ifdef __cplusplus
extern "C" {
#endif
/* Includes ------------------------------------------------------------------*/
#include <stdint.h>
#include <stddef.h>
#include <math.h>
/** @addtogroup STTS22H
* @{
*
*/
/** @defgroup Endianness definitions
* @{
*
*/
#ifndef DRV_BYTE_ORDER
#ifndef __BYTE_ORDER__
#define DRV_LITTLE_ENDIAN 1234
#define DRV_BIG_ENDIAN 4321
/** if _BYTE_ORDER is not defined, choose the endianness of your architecture
* by uncommenting the define which fits your platform endianness
*/
//#define DRV_BYTE_ORDER DRV_BIG_ENDIAN
#define DRV_BYTE_ORDER DRV_LITTLE_ENDIAN
#else /* defined __BYTE_ORDER__ */
#define DRV_LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
#define DRV_BIG_ENDIAN __ORDER_BIG_ENDIAN__
#define DRV_BYTE_ORDER __BYTE_ORDER__
#endif /* __BYTE_ORDER__*/
#endif /* DRV_BYTE_ORDER */
/**
* @}
*
*/
/** @defgroup STMicroelectronics sensors common types
* @{
*
*/
#ifndef MEMS_SHARED_TYPES
#define MEMS_SHARED_TYPES
typedef struct
{
#if DRV_BYTE_ORDER == DRV_LITTLE_ENDIAN
uint8_t bit0 : 1;
uint8_t bit1 : 1;
uint8_t bit2 : 1;
uint8_t bit3 : 1;
uint8_t bit4 : 1;
uint8_t bit5 : 1;
uint8_t bit6 : 1;
uint8_t bit7 : 1;
#elif DRV_BYTE_ORDER == DRV_BIG_ENDIAN
uint8_t bit7 : 1;
uint8_t bit6 : 1;
uint8_t bit5 : 1;
uint8_t bit4 : 1;
uint8_t bit3 : 1;
uint8_t bit2 : 1;
uint8_t bit1 : 1;
uint8_t bit0 : 1;
#endif /* DRV_BYTE_ORDER */
} bitwise_t;
#define PROPERTY_DISABLE (0U)
#define PROPERTY_ENABLE (1U)
/** @addtogroup Interfaces_Functions
* @brief This section provide a set of functions used to read and
* write a generic register of the device.
* MANDATORY: return 0 -> no Error.
* @{
*
*/
typedef int32_t (*stmdev_write_ptr)(void *, uint8_t, uint8_t *, uint16_t);
typedef int32_t (*stmdev_read_ptr)(void *, uint8_t, uint8_t *, uint16_t);
typedef struct
{
/** Component mandatory fields **/
stmdev_write_ptr write_reg;
stmdev_read_ptr read_reg;
/** Customizable optional pointer **/
void *handle;
} stmdev_ctx_t;
/**
* @}
*
*/
#endif /* MEMS_SHARED_TYPES */
#ifndef MEMS_UCF_SHARED_TYPES
#define MEMS_UCF_SHARED_TYPES
/** @defgroup Generic address-data structure definition
* @brief This structure is useful to load a predefined configuration
* of a sensor.
* You can create a sensor configuration by your own or using
* Unico / Unicleo tools available on STMicroelectronics
* web site.
*
* @{
*
*/
typedef struct
{
uint8_t address;
uint8_t data;
} ucf_line_t;
/**
* @}
*
*/
#endif /* MEMS_UCF_SHARED_TYPES */
/**
* @}
*
*/
/** @defgroup STTS22H_Infos
* @{
*
*/
/** I2C Device Address 8 bit format **/
#define STTS22H_I2C_ADD_H 0x71U
#define STTS22H_I2C_ADD_L 0x7FU
/** Device Identification (Who am I) **/
#define STTS22H_ID 0xA0U
/**
* @}
*
*/
#define STTS22H_WHOAMI 0x01U
#define STTS22H_TEMP_H_LIMIT 0x02U
typedef struct
{
uint8_t thl : 8;
} stts22h_temp_h_limit_t;
#define STTS22H_TEMP_L_LIMIT 0x03U
typedef struct
{
uint8_t tll : 8;
} stts22h_temp_l_limit_t;
#define STTS22H_CTRL 0x04U
typedef struct
{
#if DRV_BYTE_ORDER == DRV_LITTLE_ENDIAN
uint8_t one_shot : 1;
uint8_t time_out_dis : 1;
uint8_t freerun : 1;
uint8_t if_add_inc : 1;
uint8_t avg : 2;
uint8_t bdu : 1;
uint8_t low_odr_start : 1;
#elif DRV_BYTE_ORDER == DRV_BIG_ENDIAN
uint8_t low_odr_start : 1;
uint8_t bdu : 1;
uint8_t avg : 2;
uint8_t if_add_inc : 1;
uint8_t freerun : 1;
uint8_t time_out_dis : 1;
uint8_t one_shot : 1;
#endif /* DRV_BYTE_ORDER */
} stts22h_ctrl_t;
#define STTS22H_STATUS 0x05U
typedef struct
{
#if DRV_BYTE_ORDER == DRV_LITTLE_ENDIAN
uint8_t busy : 1;
uint8_t over_thh : 1;
uint8_t under_thl : 1;
uint8_t not_used_01 : 5;
#elif DRV_BYTE_ORDER == DRV_BIG_ENDIAN
uint8_t not_used_01 : 5;
uint8_t under_thl : 1;
uint8_t over_thh : 1;
uint8_t busy : 1;
#endif /* DRV_BYTE_ORDER */
} stts22h_status_t;
#define STTS22H_TEMP_L_OUT 0x06U
#define STTS22H_TEMP_H_OUT 0x07U
#define STTS22H_SOFTWARE_RESET 0x0CU
typedef struct
{
#if DRV_BYTE_ORDER == DRV_LITTLE_ENDIAN
uint8_t not_used_01 : 1;
uint8_t sw_reset : 1;
uint8_t not_used_02 : 4;
uint8_t low_odr_enable : 1;
uint8_t not_used_03 : 1;
#elif DRV_BYTE_ORDER == DRV_BIG_ENDIAN
uint8_t not_used_03 : 1;
uint8_t low_odr_enable : 1;
uint8_t not_used_02 : 4;
uint8_t sw_reset : 1;
uint8_t not_used_01 : 1;
#endif /* DRV_BYTE_ORDER */
} stts22h_software_reset_t;
/**
* @defgroup STTS22H_Register_Union
* @brief This union group all the registers having a bit-field
* description.
* This union is useful but it's not needed by the driver.
*
* REMOVING this union you are compliant with:
* MISRA-C 2012 [Rule 19.2] -> " Union are not allowed "
*
* @{
*
*/
typedef union
{
stts22h_temp_h_limit_t temp_h_limit;
stts22h_temp_l_limit_t temp_l_limit;
stts22h_ctrl_t ctrl;
stts22h_status_t status;
stts22h_software_reset_t software_reset;
bitwise_t bitwise;
uint8_t byte;
} stts22h_reg_t;
/**
* @}
*
*/
int32_t stts22h_read_reg(stmdev_ctx_t *ctx, uint8_t reg,
uint8_t *data,
uint16_t len);
int32_t stts22h_write_reg(stmdev_ctx_t *ctx, uint8_t reg,
uint8_t *data,
uint16_t len);
float_t stts22h_from_lsb_to_celsius(int16_t lsb);
typedef enum
{
STTS22H_POWER_DOWN = 0x00,
STTS22H_ONE_SHOT = 0x01,
STTS22H_1Hz = 0x04,
STTS22H_25Hz = 0x02,
STTS22H_50Hz = 0x12,
STTS22H_100Hz = 0x22,
STTS22H_200Hz = 0x32,
} stts22h_odr_temp_t;
int32_t stts22h_temp_data_rate_set(stmdev_ctx_t *ctx,
stts22h_odr_temp_t val);
int32_t stts22h_temp_data_rate_get(stmdev_ctx_t *ctx,
stts22h_odr_temp_t *val);
int32_t stts22h_block_data_update_set(stmdev_ctx_t *ctx, uint8_t val);
int32_t stts22h_block_data_update_get(stmdev_ctx_t *ctx,
uint8_t *val);
int32_t stts22h_temp_flag_data_ready_get(stmdev_ctx_t *ctx,
uint8_t *val);
int32_t stts22h_temperature_raw_get(stmdev_ctx_t *ctx, int16_t *val);
int32_t stts22h_dev_id_get(stmdev_ctx_t *ctx, uint8_t *buff);
typedef struct
{
uint8_t busy : 1;
} stts22h_dev_status_t;
int32_t stts22h_dev_status_get(stmdev_ctx_t *ctx,
stts22h_dev_status_t *val);
typedef enum
{
STTS22H_SMBUS_TIMEOUT_ENABLE = 0,
STTS22H_SMBUS_TIMEOUT_DISABLE = 1,
} stts22h_smbus_md_t;
int32_t stts22h_smbus_interface_set(stmdev_ctx_t *ctx,
stts22h_smbus_md_t val);
int32_t stts22h_smbus_interface_get(stmdev_ctx_t *ctx,
stts22h_smbus_md_t *val);
int32_t stts22h_auto_increment_set(stmdev_ctx_t *ctx, uint8_t val);
int32_t stts22h_auto_increment_get(stmdev_ctx_t *ctx, uint8_t *val);
int32_t stts22h_temp_trshld_high_set(stmdev_ctx_t *ctx, uint8_t val);
int32_t stts22h_temp_trshld_high_get(stmdev_ctx_t *ctx, uint8_t *val);
int32_t stts22h_temp_trshld_low_set(stmdev_ctx_t *ctx, uint8_t val);
int32_t stts22h_temp_trshld_low_get(stmdev_ctx_t *ctx, uint8_t *val);
typedef struct
{
uint8_t under_thl : 1;
uint8_t over_thh : 1;
} stts22h_temp_trlhd_src_t;
int32_t stts22h_temp_trshld_src_get(stmdev_ctx_t *ctx,
stts22h_temp_trlhd_src_t *val);
/**
*@}
*
*/
#ifdef __cplusplus
}
#endif
#endif /* STTS22H_REGS_H */
Reference in New Issue View Git Blame Copy Permalink