zmod4xxx_types.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2024 Renesas Electronics Corporation
 * All Rights Reserved.
 * 
 * This code is proprietary to Renesas, and is license pursuant to the terms and
 * conditions that may be accessed at:
 * https://www.renesas.com/eu/en/document/msc/renesas-software-license-terms-gas-sensor-software
 *****************************************************************************/

#ifndef _ZMOD4XXX_TYPES_H
#define _ZMOD4XXX_TYPES_H

#include <stdint.h>
#include <stdio.h>


typedef enum {
    ZMOD4XXX_OK = 0,
    ERROR_INIT_OUT_OF_RANGE =
        -1, 
    ERROR_GAS_TIMEOUT =
        -2, 
    ERROR_I2C = -3, 
    ERROR_SENSOR_UNSUPPORTED =
        -4, 
    ERROR_CONFIG_MISSING =
        -5, 
    ERROR_ACCESS_CONFLICT =
        -6, 
    ERROR_POR_EVENT =
        -7, 
    ERROR_CLEANING =
        -8, 
    ERROR_NULL_PTR =
        -9 
} zmod4xxx_err;

typedef int8_t (*zmod4xxx_i2c_ptr_t)(uint8_t addr, uint8_t reg_addr,
                                     uint8_t *data_buf, uint8_t len);

typedef void (*zmod4xxx_delay_ptr_p)(uint32_t ms);

typedef struct {
    uint8_t addr;
    uint8_t len;
    uint8_t *data_buf;
} zmod4xxx_conf_str;

typedef struct {
    uint8_t start;
    zmod4xxx_conf_str h;
    zmod4xxx_conf_str d;
    zmod4xxx_conf_str m;
    zmod4xxx_conf_str s;
    zmod4xxx_conf_str r;
    uint8_t prod_data_len;
} zmod4xxx_conf;

typedef struct {
    uint8_t i2c_addr; 
    uint8_t config[6]; 
    uint16_t mox_er; 
    uint16_t mox_lr; 
    uint16_t pid; 
    uint8_t *prod_data; 
    zmod4xxx_i2c_ptr_t read; 
    zmod4xxx_i2c_ptr_t write; 
    zmod4xxx_delay_ptr_p delay_ms; 
    zmod4xxx_conf *init_conf; 
    zmod4xxx_conf *meas_conf; 
} zmod4xxx_dev_t;

#endif /* _ZMOD4XXX_TYPES_H */