Overview

Enumerations
enum	smbus_bus_protocol_t { kSMBUS_WriteByte = 0x11U, kSMBUS_ReadByte = 0x12U, kSMBUS_WriteWord = 0x13U, kSMBUS_ReadWord = 0x14U, kSMBUS_Write32 = 0x15U, kSMBUS_Read32 = 0x16U, kSMBUS_Write64 = 0x17U, kSMBUS_Read64 = 0x18U, kSMBUS_WriteBlock = 0x19U, kSMBUS_ReadBlock = 0x1AU, kSMBUS_ProcessCall = 0x1BU, kSMBUS_BlockWriteBlockRead = 0x1CU }

Functions
void	SMBUS_Master_Init (smbus_master_handle_t handle, smbus_master_config_t config)
	SMBUS master init. More...

void	SMBUS_Master_Deinit (smbus_master_handle_t *handle)
	SMBUS master deinit. More...

status_t	SMBUS_Master_WriteByte (smbus_master_handle_t handle, smbus_master_transfer_t transfer)
	SMBUS master send byte. More...

status_t	SMBUS_Master_ReadByte (smbus_master_handle_t handle, smbus_master_transfer_t transfer)
	SMBUS master receive byte. More...

status_t	SMBUS_Master_Write (smbus_master_handle_t handle, smbus_master_transfer_t transfer, smbus_bus_protocol_t protocol)
	SMBUS master write. More...

status_t	SMBUS_Master_Read (smbus_master_handle_t handle, smbus_master_transfer_t transfer, smbus_bus_protocol_t protocol)
	SMBUS master read. More...

status_t	SMBUS_Master_ProcessCall (smbus_master_handle_t handle, smbus_master_transfer_t transfer, smbus_bus_protocol_t protocol)
	SMBUS master process call. More...

status_t	SMBUS_Master_GetDeviceID (smbus_master_handle_t handle, uint8_t deviceID)
	SMBUS master send byte. More...

void	SMBUS_Slave_Init (smbus_slave_handle_t handle, smbus_slave_config_t config)
	SMBUS slave init. More...

void	SMBUS_Slave_Deinit (smbus_slave_handle_t *handle)
	SMBUS slave deinit. More...

status_t	SMBUS_Slave_WriteByte (smbus_slave_handle_t handle, smbus_slave_transfer_t transfer)
	SMBUS slave send byte. More...

status_t	SMBUS_Slave_ReadByte (smbus_slave_handle_t handle, smbus_slave_transfer_t transfer)
	SMBUS slave receive byte. More...

status_t	SMBUS_Slave_Write (smbus_slave_handle_t handle, smbus_slave_transfer_t transfer, smbus_bus_protocol_t protocol)
	SMBUS slave write. More...

status_t	SMBUS_Slave_Read (smbus_slave_handle_t handle, smbus_slave_transfer_t transfer, smbus_bus_protocol_t protocol)
	SMBUS slave read. More...

status_t	SMBUS_Slave_ProcessCall (smbus_slave_handle_t handle, smbus_slave_transfer_t transfer, smbus_bus_protocol_t protocol)
	SMBUS slave process call. More...

void	SMBUS_Master_Port_Init (smbus_master_port_handle_t handle, uint32_t baudRate_Bps, const smbus_port_config_t config)
	SMBUS master port init. More...

void	SMBUS_Master_Port_Deinit (smbus_master_port_handle_t *handle)
	SMBUS master port deinit. More...

status_t	SMBUS_Master_Port_Write (smbus_master_port_handle_t handle, uint8_t slaveAddress, uint8_t buffer, uint32_t writeSize, uint32_t timeoutMS, uint32_t flag)
	SMBUS master port write. More...

status_t	SMBUS_Master_Port_Read (smbus_master_port_handle_t handle, uint8_t slaveAddress, uint8_t buffer, uint32_t readSize, uint32_t timeoutMS, uint32_t flag)
	SMBUS master port read. More...

void	SMBUS_Slave_Port_Init (smbus_slave_port_handle_t handle, const smbus_port_config_t config, uint8_t slaveAddress)
	SMBUS slave port init. More...

void	SMBUS_Slave_Port_Deinit (smbus_slave_port_handle_t *handle)
	SMBUS slave port deinit. More...

status_t	SMBUS_Slave_Port_Write (smbus_slave_port_handle_t handle, uint8_t buffer, uint32_t writeSize, uint32_t timeoutMS)
	SMBUS slave port write. More...

status_t	SMBUS_Slave_Port_Read (smbus_slave_port_handle_t handle, uint8_t buffer, uint32_t readSize, uint32_t timeoutMS)
	SMBUS slave port read. More...

Enumeration Type Documentation

enum smbus_bus_protocol_t

Enumerator
kSMBUS_WriteByte	write byte
kSMBUS_ReadByte	read byte
kSMBUS_WriteWord	write word
kSMBUS_ReadWord	read word
kSMBUS_Write32	write 32bits
kSMBUS_Read32	read 32bits
kSMBUS_Write64	write 64bits
kSMBUS_Read64	read 64bits
kSMBUS_WriteBlock	write block
kSMBUS_ReadBlock	read block
kSMBUS_ProcessCall	process call
kSMBUS_BlockWriteBlockRead	block write - block read process call

Function Documentation

void SMBUS_Master_Init	(	smbus_master_handle_t *	handle,
		smbus_master_config_t *	config
	)

Parameters

handle	smbus handler
config	smbus configuration pointer

void SMBUS_Master_Deinit ( smbus_master_handle_t * handle )

Parameters

handle smbus handler

status_t SMBUS_Master_WriteByte	(	smbus_master_handle_t *	handle,
		smbus_master_transfer_t *	transfer
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Master_ReadByte	(	smbus_master_handle_t *	handle,
		smbus_master_transfer_t *	transfer
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Master_Write	(	smbus_master_handle_t *	handle,
		smbus_master_transfer_t *	transfer,
		smbus_bus_protocol_t	protocol
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer
protocol	smbus transfer protocol

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Master_Read	(	smbus_master_handle_t *	handle,
		smbus_master_transfer_t *	transfer,
		smbus_bus_protocol_t	protocol
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer
protocol	smbus transfer protocol

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Master_ProcessCall	(	smbus_master_handle_t *	handle,
		smbus_master_transfer_t *	transfer,
		smbus_bus_protocol_t	protocol
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer
protocol	smbus transfer protocol

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Master_GetDeviceID	(	smbus_master_handle_t *	handle,
		uint8_t *	deviceID
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer
protocol	smbus transfer protocol

Return values

kStatus_Success if no error, otherwise failed.

void SMBUS_Slave_Init	(	smbus_slave_handle_t *	handle,
		smbus_slave_config_t *	config
	)

Parameters

handle	smbus handler
config	smbus configuration pointer

void SMBUS_Slave_Deinit ( smbus_slave_handle_t * handle )

Parameters

handle smbus handler

status_t SMBUS_Slave_WriteByte	(	smbus_slave_handle_t *	handle,
		smbus_slave_transfer_t *	transfer
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Slave_ReadByte	(	smbus_slave_handle_t *	handle,
		smbus_slave_transfer_t *	transfer
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Slave_Write	(	smbus_slave_handle_t *	handle,
		smbus_slave_transfer_t *	transfer,
		smbus_bus_protocol_t	protocol
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer
protocol	smbus transfer protocol

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Slave_Read	(	smbus_slave_handle_t *	handle,
		smbus_slave_transfer_t *	transfer,
		smbus_bus_protocol_t	protocol
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer
protocol	smbus transfer protocol

Return values

kStatus_Success if no error, otherwise failed.

status_t SMBUS_Slave_ProcessCall	(	smbus_slave_handle_t *	handle,
		smbus_slave_transfer_t *	transfer,
		smbus_bus_protocol_t	protocol
	)

Parameters

handle	smbus handler
transfer	smbus transfer configuration pointer
protocol	smbus transfer protocol

Return values

kStatus_Success if no error, otherwise failed.

void SMBUS_Master_Port_Init	(	smbus_master_port_handle_t *	handle,
		uint32_t	baudRate_Bps,
		const smbus_port_config_t *	config
	)

Parameters

handle	smbus port handler
baudRate_Bps	smbus port baudrate
config	smbus port configuration pointer

void SMBUS_Master_Port_Deinit ( smbus_master_port_handle_t * handle )

Parameters

handle smbus port handler

status_t SMBUS_Master_Port_Write	(	smbus_master_port_handle_t *	handle,
		uint8_t	slaveAddress,
		uint8_t *	buffer,
		uint32_t	writeSize,
		uint32_t	timeoutMS,
		uint32_t	flag
	)

Parameters

handle	smbus port handler
slaveAddress	smbus port baudrate
buffer	buffer address contain the data to write
writeSize	data size to write
timeoutMS	transfer timeout
flag	smbus port transfer flag

status_t SMBUS_Master_Port_Read	(	smbus_master_port_handle_t *	handle,
		uint8_t	slaveAddress,
		uint8_t *	buffer,
		uint32_t	readSize,
		uint32_t	timeoutMS,
		uint32_t	flag
	)

Parameters

handle	smbus port handler
slaveAddress	smbus port baudrate
buffer	buffer address contain the data to write
readSize	data size to read
timeoutMS	transfer timeout
flag	smbus port transfer flag

void SMBUS_Slave_Port_Init	(	smbus_slave_port_handle_t *	handle,
		const smbus_port_config_t *	config,
		uint8_t	slaveAddress
	)

Parameters

handle	smbus port handler
config	smbus port configuration pointer
slaveAddress	smbus slave address

void SMBUS_Slave_Port_Deinit ( smbus_slave_port_handle_t * handle )

Parameters

handle smbus port handler

status_t SMBUS_Slave_Port_Write	(	smbus_slave_port_handle_t *	handle,
		uint8_t *	buffer,
		uint32_t	writeSize,
		uint32_t	timeoutMS
	)

Parameters

handle	smbus port handler
buffer	buffer address contain the data to write
writeSize	data size to write
timeoutMS	transfer timeout

status_t SMBUS_Slave_Port_Read	(	smbus_slave_port_handle_t *	handle,
		uint8_t *	buffer,
		uint32_t	readSize,
		uint32_t	timeoutMS
	)

Parameters

handle	smbus port handler
buffer	buffer address contain the data to write
readSize	data size to read
timeoutMS	transfer timeout

Overview

Enumerations

Functions

Enumeration Type Documentation

Function Documentation