13#ifndef ZEPHYR_INCLUDE_DRIVERS_SMBUS_H_
14#define ZEPHYR_INCLUDE_DRIVERS_SMBUS_H_
56#define SMBUS_CMD_QUICK 0b000
79#define SMBUS_CMD_BYTE 0b001
105#define SMBUS_CMD_BYTE_DATA 0b010
133#define SMBUS_CMD_WORD_DATA 0b011
152#define SMBUS_CMD_PROC_CALL 0b100
183#define SMBUS_CMD_BLOCK 0b101
203#define SMBUS_CMD_BLOCK_PROC 0b111
207#define SMBUS_BLOCK_BYTES_MAX 32
217#define SMBUS_MODE_CONTROLLER BIT(0)
220#define SMBUS_MODE_PEC BIT(1)
223#define SMBUS_MODE_HOST_NOTIFY BIT(2)
226#define SMBUS_MODE_SMBALERT BIT(3)
243#define SMBUS_ADDRESS_ARA 0x0c
263#define SMBUS_MSG_RW_MASK BIT(0)
319#define SMBUS_DT_SPEC_GET(node_id) \
321 .bus = DEVICE_DT_GET(DT_BUS(node_id)), \
322 .addr = DT_REG_ADDR(node_id) \
333#define SMBUS_DT_SPEC_INST_GET(inst) SMBUS_DT_SPEC_GET(DT_DRV_INST(inst))
342typedef int (*smbus_api_configure_t)(
const struct device *dev,
344typedef int (*smbus_api_get_config_t)(
const struct device *dev,
346typedef int (*smbus_api_quick_t)(
const struct device *dev,
348typedef int (*smbus_api_byte_write_t)(
const struct device *dev,
350typedef int (*smbus_api_byte_read_t)(
const struct device *dev,
352typedef int (*smbus_api_byte_data_write_t)(
const struct device *dev,
355typedef int (*smbus_api_byte_data_read_t)(
const struct device *dev,
358typedef int (*smbus_api_word_data_write_t)(
const struct device *dev,
361typedef int (*smbus_api_word_data_read_t)(
const struct device *dev,
364typedef int (*smbus_api_pcall_t)(
const struct device *dev,
367typedef int (*smbus_api_block_write_t)(
const struct device *dev,
370typedef int (*smbus_api_block_read_t)(
const struct device *dev,
373typedef int (*smbus_api_block_pcall_t)(
const struct device *dev,
377typedef int (*smbus_api_smbalert_cb_t)(
const struct device *dev,
379typedef int (*smbus_api_host_notify_cb_t)(
const struct device *dev,
382__subsystem
struct smbus_driver_api {
383 smbus_api_configure_t configure;
384 smbus_api_get_config_t get_config;
406#if defined(CONFIG_SMBUS_STATS) || defined(__DOXYGEN__)
424struct smbus_device_state {
426 struct stats_smbus stats;
432#define Z_SMBUS_DEVICE_STATE_DEFINE(node_id, dev_name) \
433 static struct smbus_device_state Z_DEVICE_STATE_NAME(dev_name) \
434 __attribute__((__section__(".z_devstate")));
442#define Z_SMBUS_INIT_FN(dev_name, init_fn) \
444 UTIL_CAT(dev_name, _init)(const struct device *dev) \
446 struct smbus_device_state *state = \
447 CONTAINER_OF(dev->state, \
448 struct smbus_device_state, \
450 stats_init(&state->stats.s_hdr, STATS_SIZE_32, 4, \
451 STATS_NAME_INIT_PARMS(smbus)); \
452 stats_register(dev->name, &(state->stats.s_hdr)); \
453 return init_fn(dev); \
469 struct smbus_device_state *
state =
505#define SMBUS_DEVICE_DT_DEFINE(node_id, init_fn, pm_device, \
506 data_ptr, cfg_ptr, level, prio, \
508 Z_SMBUS_DEVICE_STATE_DEFINE(node_id, \
509 Z_DEVICE_DT_DEV_NAME(node_id)); \
510 Z_SMBUS_INIT_FN(Z_DEVICE_DT_DEV_NAME(node_id), init_fn) \
511 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_NAME(node_id), \
512 DEVICE_DT_NAME(node_id), \
513 &UTIL_CAT(Z_DEVICE_DT_DEV_NAME(node_id), _init),\
514 NULL, Z_DEVICE_DT_FLAGS(node_id), pm_device, \
515 data_ptr, cfg_ptr, level, prio, \
517 &(Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_NAME \
518 (node_id)).devstate), \
531#define SMBUS_DEVICE_DT_DEFINE(node_id, init_fn, pm_device, \
532 data_ptr, cfg_ptr, level, prio, \
534 DEVICE_DT_DEFINE(node_id, &init_fn, pm_device, \
535 data_ptr, cfg_ptr, level, prio, \
536 api_ptr, __VA_ARGS__)
549#define SMBUS_DEVICE_DT_INST_DEFINE(inst, ...) \
550 SMBUS_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
564static inline int z_impl_smbus_configure(
const struct device *dev,
567 const struct smbus_driver_api *api =
568 (
const struct smbus_driver_api *)dev->
api;
570 return api->configure(dev, dev_config);
595static inline int z_impl_smbus_get_config(
const struct device *dev,
598 const struct smbus_driver_api *api =
599 (
const struct smbus_driver_api *)dev->
api;
601 if (api->get_config ==
NULL) {
605 return api->get_config(dev, dev_config);
622 const struct smbus_driver_api *api =
623 (
const struct smbus_driver_api *)dev->
api;
625 if (api->smbus_smbalert_set_cb ==
NULL) {
629 return api->smbus_smbalert_set_cb(dev, cb);
646static inline int z_impl_smbus_smbalert_remove_cb(
const struct device *dev,
649 const struct smbus_driver_api *api =
650 (
const struct smbus_driver_api *)dev->
api;
652 if (api->smbus_smbalert_remove_cb ==
NULL) {
656 return api->smbus_smbalert_remove_cb(dev, cb);
673 const struct smbus_driver_api *api =
674 (
const struct smbus_driver_api *)dev->
api;
676 if (api->smbus_host_notify_set_cb ==
NULL) {
680 return api->smbus_host_notify_set_cb(dev, cb);
697static inline int z_impl_smbus_host_notify_remove_cb(
const struct device *dev,
700 const struct smbus_driver_api *api =
701 (
const struct smbus_driver_api *)dev->
api;
703 if (api->smbus_host_notify_remove_cb ==
NULL) {
707 return api->smbus_host_notify_remove_cb(dev, cb);
729static inline int z_impl_smbus_quick(
const struct device *dev,
uint16_t addr,
732 const struct smbus_driver_api *api =
733 (
const struct smbus_driver_api *)dev->
api;
735 if (api->smbus_quick ==
NULL) {
743 return api->smbus_quick(dev, addr, direction);
764static inline int z_impl_smbus_byte_write(
const struct device *dev,
767 const struct smbus_driver_api *api =
768 (
const struct smbus_driver_api *)dev->
api;
770 if (api->smbus_byte_write ==
NULL) {
774 return api->smbus_byte_write(dev, addr,
byte);
795static inline int z_impl_smbus_byte_read(
const struct device *dev,
798 const struct smbus_driver_api *api =
799 (
const struct smbus_driver_api *)dev->
api;
801 if (api->smbus_byte_read ==
NULL) {
805 return api->smbus_byte_read(dev, addr,
byte);
827static inline int z_impl_smbus_byte_data_write(
const struct device *dev,
831 const struct smbus_driver_api *api =
832 (
const struct smbus_driver_api *)dev->
api;
834 if (api->smbus_byte_data_write ==
NULL) {
838 return api->smbus_byte_data_write(dev, addr,
cmd,
byte);
860static inline int z_impl_smbus_byte_data_read(
const struct device *dev,
864 const struct smbus_driver_api *api =
865 (
const struct smbus_driver_api *)dev->
api;
867 if (api->smbus_byte_data_read ==
NULL) {
871 return api->smbus_byte_data_read(dev, addr,
cmd,
byte);
893static inline int z_impl_smbus_word_data_write(
const struct device *dev,
897 const struct smbus_driver_api *api =
898 (
const struct smbus_driver_api *)dev->
api;
900 if (api->smbus_word_data_write ==
NULL) {
904 return api->smbus_word_data_write(dev, addr,
cmd, word);
926static inline int z_impl_smbus_word_data_read(
const struct device *dev,
930 const struct smbus_driver_api *api =
931 (
const struct smbus_driver_api *)dev->
api;
933 if (api->smbus_word_data_read ==
NULL) {
937 return api->smbus_word_data_read(dev, addr,
cmd, word);
961static inline int z_impl_smbus_pcall(
const struct device *dev,
965 const struct smbus_driver_api *api =
966 (
const struct smbus_driver_api *)dev->
api;
968 if (api->smbus_pcall ==
NULL) {
972 return api->smbus_pcall(dev, addr,
cmd, send_word, recv_word);
995static inline int z_impl_smbus_block_write(
const struct device *dev,
999 const struct smbus_driver_api *api =
1000 (
const struct smbus_driver_api *)dev->
api;
1002 if (api->smbus_block_write ==
NULL) {
1010 return api->smbus_block_write(dev, addr,
cmd, count, buf);
1033static inline int z_impl_smbus_block_read(
const struct device *dev,
1037 const struct smbus_driver_api *api =
1038 (
const struct smbus_driver_api *)dev->
api;
1040 if (api->smbus_block_read ==
NULL) {
1044 return api->smbus_block_read(dev, addr,
cmd, count, buf);
1072static inline int z_impl_smbus_block_pcall(
const struct device *dev,
1077 const struct smbus_driver_api *api =
1078 (
const struct smbus_driver_api *)dev->
api;
1080 if (api->smbus_block_pcall ==
NULL) {
1084 return api->smbus_block_pcall(dev, addr,
cmd, snd_count, snd_buf,
1085 rcv_count, rcv_buf);
1096#include <zephyr/syscalls/smbus.h>
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:466
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_pcall(const struct device *dev, uint16_t addr, uint8_t cmd, uint16_t send_word, uint16_t *recv_word)
Perform SMBus Process Call operation.
static int smbus_host_notify_set_cb(const struct device *dev, struct smbus_callback *cb)
Add Host Notify callback for a SMBus host controller.
Definition smbus.h:670
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.
#define SMBUS_BLOCK_BYTES_MAX
Maximum number of bytes in SMBus Block protocol.
Definition smbus.h:207
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:275
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:253
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.
static int smbus_smbalert_set_cb(const struct device *dev, struct smbus_callback *cb)
Add SMBUSALERT callback for a SMBus host controller.
Definition smbus.h:619
@ SMBUS_MSG_WRITE
Write a message to SMBus peripheral.
Definition smbus.h:255
@ SMBUS_MSG_READ
Read a message from SMBus peripheral.
Definition smbus.h:257
#define CONTAINER_OF(ptr, type, field)
Get a pointer to a structure containing the element.
Definition util.h:285
#define EINVAL
Invalid argument.
Definition errno.h:60
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define NULL
Definition iar_missing_defs.h:20
state
Definition parser_state.h:29
ssize_t recv(int sock, void *buf, size_t max_len, int flags)
#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:455
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:516
struct device_state * state
Address of the common device state.
Definition device.h:518
SMBus callback structure.
Definition smbus.h:288
smbus_callback_handler_t handler
Actual callback function being called when relevant.
Definition smbus.h:293
uint8_t addr
Peripheral device address.
Definition smbus.h:296
sys_snode_t node
This should be used in driver for a callback list management.
Definition smbus.h:290
Complete SMBus DT information.
Definition smbus.h:302
uint16_t addr
Address of the SMBus peripheral device.
Definition smbus.h:306
const struct device * bus
SMBus bus.
Definition smbus.h:304