hpm_smbus.h File Reference

#include "hpm_common.h"
#include "hpm_soc_feature.h"
#include "hpm_i2c_drv.h"

Go to the source code of this file.

Functions
hpm_stat_t	hpm_smbus_master_write_byte (I2C_Type *ptr, uint8_t slave_address, uint8_t data)
	SMbus master write data. More...
hpm_stat_t	hpm_smbus_master_read_byte (I2C_Type *ptr, uint8_t slave_address, uint8_t *data)
	SMbus master read byte from certain slave device. More...
hpm_stat_t	hpm_smbus_master_write_byte_in_command (I2C_Type *ptr, uint8_t slave_address, uint8_t command, uint8_t data)
	SMbus master write byte from certain slave device in command code. More...
hpm_stat_t	hpm_smbus_master_write_word_in_command (I2C_Type *ptr, uint8_t slave_address, uint8_t command, uint16_t data)
	SMbus master write word(16bits) from certain slave device in command code. More...
hpm_stat_t	hpm_smbus_master_read_byte_in_command (I2C_Type *ptr, uint8_t slave_address, uint8_t command, uint8_t *data)
	SMbus master read byte from certain slave device in command code. More...
hpm_stat_t	hpm_smbus_master_read_word_in_command (I2C_Type *ptr, uint8_t slave_address, uint8_t command, uint16_t *data)
	SMbus master read word(16bits) from certain slave device in command code. More...
hpm_stat_t	hpm_smbus_master_write_block_in_command (I2C_Type *ptr, uint8_t slave_address, uint8_t command, uint8_t *data, uint32_t size)
	SMbus master block write from certain slave device in command code. More...
hpm_stat_t	hpm_smbus_master_read_block_in_command (I2C_Type *ptr, uint8_t slave_address, uint8_t command, uint8_t *data, uint32_t size)
	SMbus master block read from certain slave device in command code. More...
hpm_stat_t	hpm_smbus_master_write (I2C_Type *ptr, uint8_t slave_address, uint8_t *data, uint32_t size)
	SMbus master write data to certain slave device. More...
hpm_stat_t	hpm_smbus_master_read (I2C_Type *ptr, uint8_t slave_address, uint8_t *data, uint32_t size)
	SMbus master read data from certain slave device. More...
hpm_stat_t	hpm_smbus_slave_write (I2C_Type *ptr, uint8_t *data, uint32_t size)
	SMbus slave write data. More...
hpm_stat_t	hpm_smbus_slave_read (I2C_Type *ptr, uint8_t *data, uint32_t size)
	SMbus slave read data. More...

Function Documentation

hpm_smbus_master_read()

hpm_stat_t hpm_smbus_master_read	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t *	data,
		uint32_t	size
	)

SMbus master read data from certain slave device.

Read data from SMbus device

Note

size should not not greater than I2C_SOC_TRANSFER_COUNT_MAX

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[out]	data	pointer of the buffer to store data read from device
[in]	size	size of data to be read in bytes

Return values

hpm_stat_t

status_success if reading is completed without any error

hpm_smbus_master_read_block_in_command()

hpm_stat_t hpm_smbus_master_read_block_in_command	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t	command,
		uint8_t *	data,
		uint32_t	size
	)

SMbus master block read from certain slave device in command code.

block read from SMbus device in command code

Note

size should not not greater than I2C_SOC_TRANSFER_COUNT_MAX

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[in]	command	command code
[out]	data	pointer of the buffer to store data read from device
[in]	size	size of data to be read in bytes

Return values

hpm_stat_t

status_success if reading is completed without any error

hpm_smbus_master_read_byte()

hpm_stat_t hpm_smbus_master_read_byte	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t *	data
	)

SMbus master read byte from certain slave device.

Read byte from SMbus device

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[out]	data	pointer of the byte read from device

Return values

hpm_stat_t

status_success if reading is completed without any error

hpm_smbus_master_read_byte_in_command()

hpm_stat_t hpm_smbus_master_read_byte_in_command	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t	command,
		uint8_t *	data
	)

SMbus master read byte from certain slave device in command code.

read byte from SMbus device in command code

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[in]	command	command code
[in]	data	byte to be read

Return values

hpm_stat_t

status_success if reading is completed without any error

hpm_smbus_master_read_word_in_command()

hpm_stat_t hpm_smbus_master_read_word_in_command	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t	command,
		uint16_t *	data
	)

SMbus master read word(16bits) from certain slave device in command code.

read word from SMbus device in command code

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[in]	command	command code
[in]	data	word to be read

Return values

hpm_stat_t

status_success if reading is completed without any error

hpm_smbus_master_write()

hpm_stat_t hpm_smbus_master_write	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t *	data,
		uint32_t	size
	)

SMbus master write data to certain slave device.

Write data to SMbus device

Note

size should not not greater than I2C_SOC_TRANSFER_COUNT_MAX

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[in]	data	pointer of the data to be sent
[in]	size	size of data to be sent in bytes

Return values

hpm_stat_t

status_success if writing is completed without any error

hpm_smbus_master_write_block_in_command()

hpm_stat_t hpm_smbus_master_write_block_in_command	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t	command,
		uint8_t *	data,
		uint32_t	size
	)

SMbus master block write from certain slave device in command code.

block write from SMbus device in command code

Note

size should not not greater than I2C_SOC_TRANSFER_COUNT_MAX

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[in]	command	command code
[in]	data	pointer of the buffer to store data read from device
[in]	size	size of data to be read in bytes

Return values

hpm_stat_t

status_success if writing is completed without any error

hpm_smbus_master_write_byte()

hpm_stat_t hpm_smbus_master_write_byte	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t	data
	)

SMbus master write data.

write data at slave mode

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[in]	data	byte to be writed

Return values

hpm_stat_t

status_success if writing is completed without any error

hpm_smbus_master_write_byte_in_command()

hpm_stat_t hpm_smbus_master_write_byte_in_command	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t	command,
		uint8_t	data
	)

SMbus master write byte from certain slave device in command code.

write byte from SMbus device in command code

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[in]	command	command code
[in]	data	byte to be writed

Return values

hpm_stat_t

status_success if writing is completed without any error

hpm_smbus_master_write_word_in_command()

hpm_stat_t hpm_smbus_master_write_word_in_command	(	I2C_Type *	ptr,
		uint8_t	slave_address,
		uint8_t	command,
		uint16_t	data
	)

SMbus master write word(16bits) from certain slave device in command code.

write word(16bits) from SMbus device in command code

Parameters

[in]	ptr	I2C base address
[in]	slave_address	SMbus slave address
[in]	command	command code
[in]	data	word to be writed

Return values

hpm_stat_t

status_success if writing is completed without any error

hpm_smbus_slave_read()

hpm_stat_t hpm_smbus_slave_read	(	I2C_Type *	ptr,
		uint8_t *	data,
		uint32_t	size
	)

SMbus slave read data.

Read data at SMbus slave mode

Note

size should not not greater than I2C_SOC_TRANSFER_COUNT_MAX

Parameters

[in]	ptr	I2C base address
[in]	buf	pointer of the buffer to store data read from device
[in]	size	size of data to be read in bytes

Return values

hpm_stat_t

status_success if reading is completed without any error

hpm_smbus_slave_write()

hpm_stat_t hpm_smbus_slave_write	(	I2C_Type *	ptr,
		uint8_t *	data,
		uint32_t	size
	)

SMbus slave write data.

Write data at SMbus slave mode.

Note

size should not not greater than I2C_SOC_TRANSFER_COUNT_MAX

Parameters

[in]	ptr	I2C base address
[in]	buf	pointer of the buffer to store data sent from device
[in]	size	size of data to be sent in bytes

Return values

hpm_stat_t

status_success if writing is completed without any error