sdrv_pvt.h

Go to the documentation of this file.

 
#ifndef SDRV_PVT_H_
#define SDRV_PVT_H_
 
#include <sdrv_common.h>
#include <types.h>
 
/* Don't use edge alarm due to limitations of hysterisis function. */
#define SDRV_PVT_USE_EDGE_ALARM   0
 
/* Temperature threshold range */
#if CONFIG_PVT_TYPE_INT
#define PVT_TEMPERATURE_MIN (-75) /* dout_to_celsius(0x0) */
#define PVT_TEMPERATURE_MAX (230) /* dout_to_celsius(0xfff) */
#else
#define PVT_TEMPERATURE_MIN (-75.9f) /* dout_to_celsius(0x0) */
#define PVT_TEMPERATURE_MAX (230.7f) /* dout_to_celsius(0xfff) */
#endif
 
#if CONFIG_PVT_TYPE_INT
typedef int32_t sdrv_pvt_type;
#else
typedef float sdrv_pvt_type;
#endif
 
typedef enum sdrv_pvt_core_id {
    PVT_CORE0 = 0u,
    PVT_CORE1 = 1u,
    PVT_CORE_NR,
} sdrv_pvt_core_id_e;
 
typedef enum sdrv_pvt_alarm {
    PVT_HIGH_LEVEL_ALARM = 0,
    PVT_LOW_LEVEL_ALARM,
#if SDRV_PVT_USE_EDGE_ALARM
    PVT_RISING_EDGE_ALARM,
    PVT_FALLING_EDGE_ALARM,
#endif
    PVT_ALARM_NR,
} sdrv_pvt_alarm_e;
 
typedef struct sdrv_pvt_level_alarm_config {
    sdrv_pvt_type thresh_low;
    sdrv_pvt_type thresh_high;
} sdrv_pvt_level_alarm_config_t;
 
#if SDRV_PVT_USE_EDGE_ALARM
typedef struct sdrv_pvt_edge_alarm_config {
    sdrv_pvt_type hyst;
 
    sdrv_pvt_type alarm;
} sdrv_pvt_edge_alarm_config_t;
#endif
 
typedef union sdrv_pvt_alarm_config {
    sdrv_pvt_level_alarm_config_t level_alarm;
#if SDRV_PVT_USE_EDGE_ALARM
    sdrv_pvt_edge_alarm_config_t edge_alarm;
#endif
} sdrv_pvt_alarm_config_t;
 
struct sdrv_pvt;
 
typedef void (*sdrv_pvt_alarm_cb_t)(struct sdrv_pvt *dev,
                                    sdrv_pvt_core_id_e core,
                                    sdrv_pvt_alarm_e alarm, void *arg);
 
typedef struct sdrv_pvt_core {
    uint32_t irq;
    sdrv_pvt_alarm_cb_t alarm_cb;
    void *cb_arg;
    uint32_t alarm_enable_mask;
} sdrv_pvt_core_t;
 
typedef struct sdrv_pvt {
    paddr_t base;
    sdrv_pvt_core_t core[PVT_CORE_NR];
} sdrv_pvt_t;
 
enum sdrv_pvt_error {
    SDRV_PVT_INVALID_PARAM = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_PVT, 0),
    SDRV_PVT_NOT_STARTED = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_PVT, 1),
};
 
status_t sdrv_pvt_init(sdrv_pvt_t *dev);
 
status_t sdrv_pvt_deinit(sdrv_pvt_t *dev);
 
status_t sdrv_pvt_start(sdrv_pvt_t *dev);
 
status_t sdrv_pvt_stop(sdrv_pvt_t *dev);
 
status_t sdrv_pvt_power_down(sdrv_pvt_t *dev);
 
status_t sdrv_pvt_get(sdrv_pvt_t *dev, sdrv_pvt_type *temperature);
 
status_t sdrv_pvt_register_alarm_cb(sdrv_pvt_t *dev, sdrv_pvt_core_id_e core,
                                    sdrv_pvt_alarm_cb_t alarm_cb, void *arg);
 
status_t sdrv_pvt_enable_alarm(sdrv_pvt_t *dev, sdrv_pvt_core_id_e core,
                               sdrv_pvt_alarm_e alarm,
                               const sdrv_pvt_alarm_config_t *config);
 
status_t sdrv_pvt_disable_alarm(sdrv_pvt_t *dev, sdrv_pvt_core_id_e core,
                                sdrv_pvt_alarm_e alarm);
 
#endif /* SDRV_PVT_H_ */