hpm_pmbus.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef HPM_PMBUS_H
#define HPM_PMBUS_H
 
#include "hpm_common.h"
#include "hpm_soc_feature.h"
#include "hpm_i2c_drv.h"
#include "hpm_pmbus_def.h"
 
typedef struct {
    uint8_t command; 
    uint32_t len;    
    bool read;       
    bool pec_check;  
    uint8_t *data;   
} hpm_pmbus_complete_cb_cfg_t;
 
typedef void (*hpm_pmbus_complete_cb_t)(I2C_Type *base, hpm_pmbus_complete_cb_cfg_t *cfg);
 
typedef enum {
    none            = 0,    
    write_byte      = 1,    
    read_byte       = 2,    
    write_word      = 3,    
    read_word       = 4,    
    write_block     = 5,    
    read_block      = 6,    
    send_byte       = 7,    
    mfr_defined     = 8,    
    extended_command = 9,   
} hpm_pmbus_transaction_type;
 
typedef struct {
    uint8_t command_code;
    hpm_pmbus_transaction_type write_transaction_type;
    hpm_pmbus_transaction_type read_transaction_type;
    uint32_t data_length;
} hpm_pmbus_cmd_param_t;
 
typedef struct {
    bool is_valid;        
    uint8_t *wdata;       
    uint8_t *rdata;       
    uint32_t data_length; 
    hpm_pmbus_complete_cb_t callback; 
} hpm_pmbus_slave_cfg_t;
 
enum {
    status_pmbus_not_support_cmd = MAKE_STATUS(status_group_pmbus, 1),
    status_pmbus_not_transaction_type = MAKE_STATUS(status_group_pmbus, 2),
};
 
#ifdef __cplusplus
extern "C"
{
#endif
void hpm_pmbus_isr_handler(I2C_Type *ptr);
 
hpm_stat_t hpm_pmbus_slave_init(I2C_Type *ptr, uint8_t slave_addr);
 
hpm_stat_t hpm_pmbus_master_read(I2C_Type *ptr, uint8_t slave_address, uint8_t command, uint8_t *data, uint32_t *len);
 
hpm_stat_t hpm_pmbus_master_write(I2C_Type *ptr, uint8_t slave_address, uint8_t command, uint8_t *data, uint32_t len);
 
hpm_stat_t hpm_pmbus_slave_command_transaction_install(I2C_Type *ptr, uint8_t command, uint8_t *wdata, uint8_t *rdata, uint32_t len, hpm_pmbus_complete_cb_t callback);
 
hpm_stat_t hpm_pmbus_slave_command_transaction_uninstall(I2C_Type *ptr, uint8_t command);
 
#ifdef __cplusplus
}
#endif
 
#endif