7#ifndef ZEPHYR_INCLUDE_DRIVERS_SMBUS_H_
8#define ZEPHYR_INCLUDE_DRIVERS_SMBUS_H_
46#define SMBUS_CMD_QUICK 0b000
69#define SMBUS_CMD_BYTE 0b001
95#define SMBUS_CMD_BYTE_DATA 0b010
123#define SMBUS_CMD_WORD_DATA 0b011
142#define SMBUS_CMD_PROC_CALL 0b100
173#define SMBUS_CMD_BLOCK 0b101
193#define SMBUS_CMD_BLOCK_PROC 0b111
197#define SMBUS_BLOCK_BYTES_MAX 32
207#define SMBUS_MODE_CONTROLLER BIT(0)
210#define SMBUS_MODE_PEC BIT(1)
213#define SMBUS_MODE_HOST_NOTIFY BIT(2)
216#define SMBUS_MODE_SMBALERT BIT(3)
233#define SMBUS_ADDRESS_ARA 0x0c
253#define SMBUS_MSG_RW_MASK BIT(0)
309#define SMBUS_DT_SPEC_GET(node_id) \
311 .bus = DEVICE_DT_GET(DT_BUS(node_id)), \
312 .addr = DT_REG_ADDR(node_id) \
323#define SMBUS_DT_SPEC_INST_GET(inst) SMBUS_DT_SPEC_GET(DT_DRV_INST(inst))
332typedef int (*smbus_api_configure_t)(
const struct device *dev,
334typedef int (*smbus_api_get_config_t)(
const struct device *dev,
336typedef int (*smbus_api_quick_t)(
const struct device *dev,
338typedef int (*smbus_api_byte_write_t)(
const struct device *dev,
340typedef int (*smbus_api_byte_read_t)(
const struct device *dev,
342typedef int (*smbus_api_byte_data_write_t)(
const struct device *dev,
345typedef int (*smbus_api_byte_data_read_t)(
const struct device *dev,
348typedef int (*smbus_api_word_data_write_t)(
const struct device *dev,
351typedef int (*smbus_api_word_data_read_t)(
const struct device *dev,
354typedef int (*smbus_api_pcall_t)(
const struct device *dev,
357typedef int (*smbus_api_block_write_t)(
const struct device *dev,
360typedef int (*smbus_api_block_read_t)(
const struct device *dev,
363typedef int (*smbus_api_block_pcall_t)(
const struct device *dev,
367typedef int (*smbus_api_smbalert_cb_t)(
const struct device *dev,
369typedef int (*smbus_api_host_notify_cb_t)(
const struct device *dev,
372__subsystem
struct smbus_driver_api {
373 smbus_api_configure_t configure;
374 smbus_api_get_config_t get_config;
396#if defined(CONFIG_SMBUS_STATS) || defined(__DOXYGEN__)
414struct smbus_device_state {
416 struct stats_smbus stats;
422#define Z_SMBUS_DEVICE_STATE_DEFINE(node_id, dev_name) \
423 static struct smbus_device_state Z_DEVICE_STATE_NAME(dev_name) \
424 __attribute__((__section__(".z_devstate")));
432#define Z_SMBUS_INIT_FN(dev_name, init_fn) \
434 UTIL_CAT(dev_name, _init)(const struct device *dev) \
436 struct smbus_device_state *state = \
437 CONTAINER_OF(dev->state, \
438 struct smbus_device_state, \
440 stats_init(&state->stats.s_hdr, STATS_SIZE_32, 4, \
441 STATS_NAME_INIT_PARMS(smbus)); \
442 stats_register(dev->name, &(state->stats.s_hdr)); \
443 return init_fn(dev); \
459 struct smbus_device_state *
state =
495#define SMBUS_DEVICE_DT_DEFINE(node_id, init_fn, pm_device, \
496 data_ptr, cfg_ptr, level, prio, \
498 Z_SMBUS_DEVICE_STATE_DEFINE(node_id, \
499 Z_DEVICE_DT_DEV_NAME(node_id)); \
500 Z_SMBUS_INIT_FN(Z_DEVICE_DT_DEV_NAME(node_id), init_fn) \
501 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_NAME(node_id), \
502 DEVICE_DT_NAME(node_id), \
503 &UTIL_CAT(Z_DEVICE_DT_DEV_NAME(node_id), _init),\
505 data_ptr, cfg_ptr, level, prio, \
507 &(Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_NAME \
508 (node_id)).devstate), \
521#define SMBUS_DEVICE_DT_DEFINE(node_id, init_fn, pm_device, \
522 data_ptr, cfg_ptr, level, prio, \
524 DEVICE_DT_DEFINE(node_id, &init_fn, pm_device, \
525 data_ptr, cfg_ptr, level, prio, \
526 api_ptr, __VA_ARGS__)
539#define SMBUS_DEVICE_DT_INST_DEFINE(inst, ...) \
540 SMBUS_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
554static inline int z_impl_smbus_configure(
const struct device *dev,
557 const struct smbus_driver_api *api =
558 (
const struct smbus_driver_api *)dev->
api;
560 return api->configure(dev, dev_config);
585static inline int z_impl_smbus_get_config(
const struct device *dev,
588 const struct smbus_driver_api *api =
589 (
const struct smbus_driver_api *)dev->
api;
591 if (api->get_config == NULL) {
595 return api->get_config(dev, dev_config);
612static inline int z_impl_smbus_smbalert_set_cb(
const struct device *dev,
615 const struct smbus_driver_api *api =
616 (
const struct smbus_driver_api *)dev->
api;
618 if (api->smbus_smbalert_set_cb == NULL) {
622 return api->smbus_smbalert_set_cb(dev, cb);
639static inline int z_impl_smbus_smbalert_remove_cb(
const struct device *dev,
642 const struct smbus_driver_api *api =
643 (
const struct smbus_driver_api *)dev->
api;
645 if (api->smbus_smbalert_remove_cb == NULL) {
649 return api->smbus_smbalert_remove_cb(dev, cb);
666static inline int z_impl_smbus_host_notify_set_cb(
const struct device *dev,
669 const struct smbus_driver_api *api =
670 (
const struct smbus_driver_api *)dev->
api;
672 if (api->smbus_host_notify_set_cb == NULL) {
676 return api->smbus_host_notify_set_cb(dev, cb);
693static inline int z_impl_smbus_host_notify_remove_cb(
const struct device *dev,
696 const struct smbus_driver_api *api =
697 (
const struct smbus_driver_api *)dev->
api;
699 if (api->smbus_host_notify_remove_cb == NULL) {
703 return api->smbus_host_notify_remove_cb(dev, cb);
725static inline int z_impl_smbus_quick(
const struct device *dev,
uint16_t addr,
728 const struct smbus_driver_api *api =
729 (
const struct smbus_driver_api *)dev->
api;
731 if (api->smbus_quick == NULL) {
739 return api->smbus_quick(dev, addr, direction);
760static inline int z_impl_smbus_byte_write(
const struct device *dev,
763 const struct smbus_driver_api *api =
764 (
const struct smbus_driver_api *)dev->
api;
766 if (api->smbus_byte_write == NULL) {
770 return api->smbus_byte_write(dev, addr,
byte);
791static inline int z_impl_smbus_byte_read(
const struct device *dev,
794 const struct smbus_driver_api *api =
795 (
const struct smbus_driver_api *)dev->
api;
797 if (api->smbus_byte_read == NULL) {
801 return api->smbus_byte_read(dev, addr,
byte);
823static inline int z_impl_smbus_byte_data_write(
const struct device *dev,
827 const struct smbus_driver_api *api =
828 (
const struct smbus_driver_api *)dev->
api;
830 if (api->smbus_byte_data_write == NULL) {
834 return api->smbus_byte_data_write(dev, addr,
cmd,
byte);
856static inline int z_impl_smbus_byte_data_read(
const struct device *dev,
860 const struct smbus_driver_api *api =
861 (
const struct smbus_driver_api *)dev->
api;
863 if (api->smbus_byte_data_read == NULL) {
867 return api->smbus_byte_data_read(dev, addr,
cmd,
byte);
889static inline int z_impl_smbus_word_data_write(
const struct device *dev,
893 const struct smbus_driver_api *api =
894 (
const struct smbus_driver_api *)dev->
api;
896 if (api->smbus_word_data_write == NULL) {
900 return api->smbus_word_data_write(dev, addr,
cmd, word);
922static inline int z_impl_smbus_word_data_read(
const struct device *dev,
926 const struct smbus_driver_api *api =
927 (
const struct smbus_driver_api *)dev->
api;
929 if (api->smbus_word_data_read == NULL) {
933 return api->smbus_word_data_read(dev, addr,
cmd, word);
957static inline int z_impl_smbus_pcall(
const struct device *dev,
961 const struct smbus_driver_api *api =
962 (
const struct smbus_driver_api *)dev->
api;
964 if (api->smbus_pcall == NULL) {
968 return api->smbus_pcall(dev, addr,
cmd, send_word, recv_word);
991static inline int z_impl_smbus_block_write(
const struct device *dev,
995 const struct smbus_driver_api *api =
996 (
const struct smbus_driver_api *)dev->
api;
998 if (api->smbus_block_write == NULL) {
1006 return api->smbus_block_write(dev, addr,
cmd, count, buf);
1029static inline int z_impl_smbus_block_read(
const struct device *dev,
1033 const struct smbus_driver_api *api =
1034 (
const struct smbus_driver_api *)dev->
api;
1036 if (api->smbus_block_read == NULL) {
1040 return api->smbus_block_read(dev, addr,
cmd, count, buf);
1068static inline int z_impl_smbus_block_pcall(
const struct device *dev,
1073 const struct smbus_driver_api *api =
1074 (
const struct smbus_driver_api *)dev->
api;
1076 if (api->smbus_block_pcall == NULL) {
1080 return api->smbus_block_pcall(dev, addr,
cmd, snd_count, snd_buf,
1081 rcv_count, rcv_buf);
1092#include <syscalls/smbus.h>
static ssize_t recv(int sock, void *buf, size_t max_len, int flags)
POSIX wrapper for zsock_recv.
Definition: socket.h:809
static void cmd(uint32_t command)
Execute a display list command by co-processor engine.
Definition: ft8xx_reference_api.h:153
struct _snode sys_snode_t
Single-linked list node structure.
Definition: slist.h:39
static void smbus_xfer_stats(const struct device *dev, uint8_t sent, uint8_t recv)
Updates the SMBus stats.
Definition: smbus.h:456
int smbus_byte_data_read(const struct device *dev, uint16_t addr, uint8_t cmd, uint8_t *byte)
Perform SMBus Byte Data Read operation.
int smbus_host_notify_set_cb(const struct device *dev, struct smbus_callback *cb)
Add Host Notify callback for a SMBus host controller.
int smbus_pcall(const struct device *dev, uint16_t addr, uint8_t cmd, uint16_t send_word, uint16_t *recv_word)
Perform SMBus Process Call operation.
int smbus_configure(const struct device *dev, uint32_t dev_config)
Configure operation of a SMBus host controller.
int smbus_block_write(const struct device *dev, uint16_t addr, uint8_t cmd, uint8_t count, uint8_t *buf)
Perform SMBus Block Write operation.
int smbus_smbalert_set_cb(const struct device *dev, struct smbus_callback *cb)
Add SMBUSALERT callback for a SMBus host controller.
#define SMBUS_BLOCK_BYTES_MAX
Maximum number of bytes in SMBus Block protocol.
Definition: smbus.h:197
int smbus_block_read(const struct device *dev, uint16_t addr, uint8_t cmd, uint8_t *count, uint8_t *buf)
Perform SMBus Block Read operation.
int smbus_block_pcall(const struct device *dev, uint16_t addr, uint8_t cmd, uint8_t snd_count, uint8_t *snd_buf, uint8_t *rcv_count, uint8_t *rcv_buf)
Perform SMBus Block Process Call operation.
void(* smbus_callback_handler_t)(const struct device *dev, struct smbus_callback *cb, uint8_t addr)
Define SMBus callback handler function signature.
Definition: smbus.h:265
int smbus_word_data_read(const struct device *dev, uint16_t addr, uint8_t cmd, uint16_t *word)
Perform SMBus Word Data Read operation.
int smbus_byte_write(const struct device *dev, uint16_t addr, uint8_t byte)
Perform SMBus Byte Write operation.
int smbus_get_config(const struct device *dev, uint32_t *dev_config)
Get configuration of a SMBus host controller.
int smbus_host_notify_remove_cb(const struct device *dev, struct smbus_callback *cb)
Remove Host Notify callback from a SMBus host controller.
int smbus_quick(const struct device *dev, uint16_t addr, enum smbus_direction direction)
Perform SMBus Quick operation.
int smbus_smbalert_remove_cb(const struct device *dev, struct smbus_callback *cb)
Remove SMBUSALERT callback from a SMBus host controller.
smbus_direction
SMBus read / write direction.
Definition: smbus.h:243
int smbus_byte_read(const struct device *dev, uint16_t addr, uint8_t *byte)
Perform SMBus Byte Read operation.
int smbus_byte_data_write(const struct device *dev, uint16_t addr, uint8_t cmd, uint8_t byte)
Perform SMBus Byte Data Write operation.
int smbus_word_data_write(const struct device *dev, uint16_t addr, uint8_t cmd, uint16_t word)
Perform SMBus Word Data Write operation.
@ SMBUS_MSG_WRITE
Write a message to SMBus peripheral.
Definition: smbus.h:245
@ SMBUS_MSG_READ
Read a message from SMBus peripheral.
Definition: smbus.h:247
#define CONTAINER_OF(ptr, type, field)
Get a pointer to a structure containing the element.
Definition: util.h:247
#define EINVAL
Invalid argument.
Definition: errno.h:61
#define ENOSYS
Function not implemented.
Definition: errno.h:83
state
Definition: parser_state.h:29
#define STATS_NAME_END(name__)
Definition: stats.h:391
#define STATS_NAME(name__, entry__)
Definition: stats.h:390
#define STATS_SECT_END
Ends a stats group struct definition.
Definition: stats.h:89
#define STATS_SECT_ENTRY32(var__)
Definition: stats.h:359
#define STATS_INC(group__, var__)
Definition: stats.h:364
#define STATS_NAME_START(name__)
Definition: stats.h:389
#define STATS_INCN(group__, var__, n__)
Definition: stats.h:363
#define STATS_SECT_START(group__)
Definition: stats.h:354
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
Runtime device dynamic structure (in RAM) per driver instance.
Definition: device.h:354
Runtime device structure (in ROM) per driver instance.
Definition: device.h:381
const void * api
Address of the API structure exposed by the device instance.
Definition: device.h:387
struct device_state * state
Address of the common device state.
Definition: device.h:389
SMBus callback structure.
Definition: smbus.h:278
smbus_callback_handler_t handler
Actual callback function being called when relevant.
Definition: smbus.h:283
uint8_t addr
Peripheral device address.
Definition: smbus.h:286
sys_snode_t node
This should be used in driver for a callback list management.
Definition: smbus.h:280
Complete SMBus DT information.
Definition: smbus.h:292
uint16_t addr
Address of the SMBus peripheral device.
Definition: smbus.h:296
const struct device * bus
SMBus bus.
Definition: smbus.h:294