Zephyr Project API  3.4.0
A Scalable Open Source RTOS
smbus.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_DRIVERS_SMBUS_H_
8#define ZEPHYR_INCLUDE_DRIVERS_SMBUS_H_
9
17#include <zephyr/types.h>
18#include <zephyr/device.h>
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
46#define SMBUS_CMD_QUICK 0b000
47
69#define SMBUS_CMD_BYTE 0b001
70
95#define SMBUS_CMD_BYTE_DATA 0b010
96
123#define SMBUS_CMD_WORD_DATA 0b011
124
142#define SMBUS_CMD_PROC_CALL 0b100
143
173#define SMBUS_CMD_BLOCK 0b101
174
193#define SMBUS_CMD_BLOCK_PROC 0b111
197#define SMBUS_BLOCK_BYTES_MAX 32
198
207#define SMBUS_MODE_CONTROLLER BIT(0)
208
210#define SMBUS_MODE_PEC BIT(1)
211
213#define SMBUS_MODE_HOST_NOTIFY BIT(2)
214
216#define SMBUS_MODE_SMBALERT BIT(3)
217
233#define SMBUS_ADDRESS_ARA 0x0c
234
248};
249
253#define SMBUS_MSG_RW_MASK BIT(0)
256struct smbus_callback;
257
265typedef void (*smbus_callback_handler_t)(const struct device *dev,
266 struct smbus_callback *cb,
267 uint8_t addr);
268
281
284
287};
288
296 const struct device *bus;
298};
299
310#define SMBUS_DT_SPEC_GET(node_id) \
311 { \
312 .bus = DEVICE_DT_GET(DT_BUS(node_id)), \
313 .addr = DT_REG_ADDR(node_id) \
314 }
315
324#define SMBUS_DT_SPEC_INST_GET(inst) SMBUS_DT_SPEC_GET(DT_DRV_INST(inst))
325
333typedef int (*smbus_api_configure_t)(const struct device *dev,
334 uint32_t dev_config);
335typedef int (*smbus_api_get_config_t)(const struct device *dev,
336 uint32_t *dev_config);
337typedef int (*smbus_api_quick_t)(const struct device *dev,
338 uint16_t addr, enum smbus_direction);
339typedef int (*smbus_api_byte_write_t)(const struct device *dev,
340 uint16_t addr, uint8_t byte);
341typedef int (*smbus_api_byte_read_t)(const struct device *dev,
342 uint16_t addr, uint8_t *byte);
343typedef int (*smbus_api_byte_data_write_t)(const struct device *dev,
344 uint16_t addr, uint8_t cmd,
345 uint8_t byte);
346typedef int (*smbus_api_byte_data_read_t)(const struct device *dev,
347 uint16_t addr, uint8_t cmd,
348 uint8_t *byte);
349typedef int (*smbus_api_word_data_write_t)(const struct device *dev,
350 uint16_t addr, uint8_t cmd,
351 uint16_t word);
352typedef int (*smbus_api_word_data_read_t)(const struct device *dev,
353 uint16_t addr, uint8_t cmd,
354 uint16_t *word);
355typedef int (*smbus_api_pcall_t)(const struct device *dev,
356 uint16_t addr, uint8_t cmd,
357 uint16_t send_word, uint16_t *recv_word);
358typedef int (*smbus_api_block_write_t)(const struct device *dev,
359 uint16_t addr, uint8_t cmd,
360 uint8_t count, uint8_t *buf);
361typedef int (*smbus_api_block_read_t)(const struct device *dev,
362 uint16_t addr, uint8_t cmd,
363 uint8_t *count, uint8_t *buf);
364typedef int (*smbus_api_block_pcall_t)(const struct device *dev,
365 uint16_t addr, uint8_t cmd,
366 uint8_t send_count, uint8_t *send_buf,
367 uint8_t *recv_count, uint8_t *recv_buf);
368typedef int (*smbus_api_smbalert_cb_t)(const struct device *dev,
369 struct smbus_callback *cb);
370typedef int (*smbus_api_host_notify_cb_t)(const struct device *dev,
371 struct smbus_callback *cb);
372
373__subsystem struct smbus_driver_api {
374 smbus_api_configure_t configure;
375 smbus_api_get_config_t get_config;
376 smbus_api_quick_t smbus_quick;
377 smbus_api_byte_write_t smbus_byte_write;
378 smbus_api_byte_read_t smbus_byte_read;
379 smbus_api_byte_data_write_t smbus_byte_data_write;
380 smbus_api_byte_data_read_t smbus_byte_data_read;
381 smbus_api_word_data_write_t smbus_word_data_write;
382 smbus_api_word_data_read_t smbus_word_data_read;
383 smbus_api_pcall_t smbus_pcall;
384 smbus_api_block_write_t smbus_block_write;
385 smbus_api_block_read_t smbus_block_read;
386 smbus_api_block_pcall_t smbus_block_pcall;
387 smbus_api_smbalert_cb_t smbus_smbalert_set_cb;
388 smbus_api_smbalert_cb_t smbus_smbalert_remove_cb;
389 smbus_api_host_notify_cb_t smbus_host_notify_set_cb;
390 smbus_api_host_notify_cb_t smbus_host_notify_remove_cb;
391};
392
397#if defined(CONFIG_SMBUS_STATS) || defined(__DOXYGEN__)
398
399#include <zephyr/stats/stats.h>
400
403STATS_SECT_START(smbus)
404STATS_SECT_ENTRY32(bytes_read)
405STATS_SECT_ENTRY32(bytes_written)
406STATS_SECT_ENTRY32(command_count)
408
409STATS_NAME_START(smbus)
410STATS_NAME(smbus, bytes_read)
411STATS_NAME(smbus, bytes_written)
412STATS_NAME(smbus, command_count)
413STATS_NAME_END(smbus);
414
415struct smbus_device_state {
416 struct device_state devstate;
417 struct stats_smbus stats;
418};
419
423#define Z_SMBUS_DEVICE_STATE_DEFINE(node_id, dev_name) \
424 static struct smbus_device_state Z_DEVICE_STATE_NAME(dev_name) \
425 __attribute__((__section__(".z_devstate")));
426
433#define Z_SMBUS_INIT_FN(dev_name, init_fn) \
434 static inline int \
435 UTIL_CAT(dev_name, _init)(const struct device *dev) \
436 { \
437 struct smbus_device_state *state = \
438 CONTAINER_OF(dev->state, \
439 struct smbus_device_state, \
440 devstate); \
441 stats_init(&state->stats.s_hdr, STATS_SIZE_32, 4, \
442 STATS_NAME_INIT_PARMS(smbus)); \
443 stats_register(dev->name, &(state->stats.s_hdr)); \
444 return init_fn(dev); \
445 }
446
457static inline void smbus_xfer_stats(const struct device *dev, uint8_t sent,
459{
460 struct smbus_device_state *state =
461 CONTAINER_OF(dev->state, struct smbus_device_state, devstate);
462
463 STATS_INC(state->stats, command_count);
464 STATS_INCN(state->stats, bytes_read, recv);
465 STATS_INCN(state->stats, bytes_written, sent);
466}
467
496#define SMBUS_DEVICE_DT_DEFINE(node_id, init_fn, pm_device, \
497 data_ptr, cfg_ptr, level, prio, \
498 api_ptr, ...) \
499 Z_SMBUS_DEVICE_STATE_DEFINE(node_id, \
500 Z_DEVICE_DT_DEV_NAME(node_id)); \
501 Z_SMBUS_INIT_FN(Z_DEVICE_DT_DEV_NAME(node_id), init_fn) \
502 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_NAME(node_id), \
503 DEVICE_DT_NAME(node_id), \
504 &UTIL_CAT(Z_DEVICE_DT_DEV_NAME(node_id), _init),\
505 pm_device, \
506 data_ptr, cfg_ptr, level, prio, \
507 api_ptr, \
508 &(Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_NAME \
509 (node_id)).devstate), \
510 __VA_ARGS__)
511
512#else /* CONFIG_SMBUS_STATS */
513
514static inline void smbus_xfer_stats(const struct device *dev, uint8_t sent,
516{
517 ARG_UNUSED(dev);
518 ARG_UNUSED(sent);
519 ARG_UNUSED(recv);
520}
521
522#define SMBUS_DEVICE_DT_DEFINE(node_id, init_fn, pm_device, \
523 data_ptr, cfg_ptr, level, prio, \
524 api_ptr, ...) \
525 DEVICE_DT_DEFINE(node_id, &init_fn, pm_device, \
526 data_ptr, cfg_ptr, level, prio, \
527 api_ptr, __VA_ARGS__)
528
529#endif /* CONFIG_SMBUS_STATS */
530
540#define SMBUS_DEVICE_DT_INST_DEFINE(inst, ...) \
541 SMBUS_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
542
553__syscall int smbus_configure(const struct device *dev, uint32_t dev_config);
554
555static inline int z_impl_smbus_configure(const struct device *dev,
556 uint32_t dev_config)
557{
558 const struct smbus_driver_api *api =
559 (const struct smbus_driver_api *)dev->api;
560
561 return api->configure(dev, dev_config);
562}
563
584__syscall int smbus_get_config(const struct device *dev, uint32_t *dev_config);
585
586static inline int z_impl_smbus_get_config(const struct device *dev,
587 uint32_t *dev_config)
588{
589 const struct smbus_driver_api *api =
590 (const struct smbus_driver_api *)dev->api;
591
592 if (api->get_config == NULL) {
593 return -ENOSYS;
594 }
595
596 return api->get_config(dev, dev_config);
597}
598
610__syscall int smbus_smbalert_set_cb(const struct device *dev,
611 struct smbus_callback *cb);
612
613static inline int z_impl_smbus_smbalert_set_cb(const struct device *dev,
614 struct smbus_callback *cb)
615{
616 const struct smbus_driver_api *api =
617 (const struct smbus_driver_api *)dev->api;
618
619 if (api->smbus_smbalert_set_cb == NULL) {
620 return -ENOSYS;
621 }
622
623 return api->smbus_smbalert_set_cb(dev, cb);
624}
625
637__syscall int smbus_smbalert_remove_cb(const struct device *dev,
638 struct smbus_callback *cb);
639
640static inline int z_impl_smbus_smbalert_remove_cb(const struct device *dev,
641 struct smbus_callback *cb)
642{
643 const struct smbus_driver_api *api =
644 (const struct smbus_driver_api *)dev->api;
645
646 if (api->smbus_smbalert_remove_cb == NULL) {
647 return -ENOSYS;
648 }
649
650 return api->smbus_smbalert_remove_cb(dev, cb);
651}
652
664__syscall int smbus_host_notify_set_cb(const struct device *dev,
665 struct smbus_callback *cb);
666
667static inline int z_impl_smbus_host_notify_set_cb(const struct device *dev,
668 struct smbus_callback *cb)
669{
670 const struct smbus_driver_api *api =
671 (const struct smbus_driver_api *)dev->api;
672
673 if (api->smbus_host_notify_set_cb == NULL) {
674 return -ENOSYS;
675 }
676
677 return api->smbus_host_notify_set_cb(dev, cb);
678}
679
691__syscall int smbus_host_notify_remove_cb(const struct device *dev,
692 struct smbus_callback *cb);
693
694static inline int z_impl_smbus_host_notify_remove_cb(const struct device *dev,
695 struct smbus_callback *cb)
696{
697 const struct smbus_driver_api *api =
698 (const struct smbus_driver_api *)dev->api;
699
700 if (api->smbus_host_notify_remove_cb == NULL) {
701 return -ENOSYS;
702 }
703
704 return api->smbus_host_notify_remove_cb(dev, cb);
705}
706
723__syscall int smbus_quick(const struct device *dev, uint16_t addr,
724 enum smbus_direction direction);
725
726static inline int z_impl_smbus_quick(const struct device *dev, uint16_t addr,
727 enum smbus_direction direction)
728{
729 const struct smbus_driver_api *api =
730 (const struct smbus_driver_api *)dev->api;
731
732 if (api->smbus_quick == NULL) {
733 return -ENOSYS;
734 }
735
736 if (direction != SMBUS_MSG_READ && direction != SMBUS_MSG_WRITE) {
737 return -EINVAL;
738 }
739
740 return api->smbus_quick(dev, addr, direction);
741}
742
758__syscall int smbus_byte_write(const struct device *dev, uint16_t addr,
759 uint8_t byte);
760
761static inline int z_impl_smbus_byte_write(const struct device *dev,
762 uint16_t addr, uint8_t byte)
763{
764 const struct smbus_driver_api *api =
765 (const struct smbus_driver_api *)dev->api;
766
767 if (api->smbus_byte_write == NULL) {
768 return -ENOSYS;
769 }
770
771 return api->smbus_byte_write(dev, addr, byte);
772}
773
789__syscall int smbus_byte_read(const struct device *dev, uint16_t addr,
790 uint8_t *byte);
791
792static inline int z_impl_smbus_byte_read(const struct device *dev,
793 uint16_t addr, uint8_t *byte)
794{
795 const struct smbus_driver_api *api =
796 (const struct smbus_driver_api *)dev->api;
797
798 if (api->smbus_byte_read == NULL) {
799 return -ENOSYS;
800 }
801
802 return api->smbus_byte_read(dev, addr, byte);
803}
804
821__syscall int smbus_byte_data_write(const struct device *dev, uint16_t addr,
822 uint8_t cmd, uint8_t byte);
823
824static inline int z_impl_smbus_byte_data_write(const struct device *dev,
825 uint16_t addr, uint8_t cmd,
826 uint8_t byte)
827{
828 const struct smbus_driver_api *api =
829 (const struct smbus_driver_api *)dev->api;
830
831 if (api->smbus_byte_data_write == NULL) {
832 return -ENOSYS;
833 }
834
835 return api->smbus_byte_data_write(dev, addr, cmd, byte);
836}
837
854__syscall int smbus_byte_data_read(const struct device *dev, uint16_t addr,
855 uint8_t cmd, uint8_t *byte);
856
857static inline int z_impl_smbus_byte_data_read(const struct device *dev,
858 uint16_t addr, uint8_t cmd,
859 uint8_t *byte)
860{
861 const struct smbus_driver_api *api =
862 (const struct smbus_driver_api *)dev->api;
863
864 if (api->smbus_byte_data_read == NULL) {
865 return -ENOSYS;
866 }
867
868 return api->smbus_byte_data_read(dev, addr, cmd, byte);
869}
870
887__syscall int smbus_word_data_write(const struct device *dev, uint16_t addr,
888 uint8_t cmd, uint16_t word);
889
890static inline int z_impl_smbus_word_data_write(const struct device *dev,
891 uint16_t addr, uint8_t cmd,
892 uint16_t word)
893{
894 const struct smbus_driver_api *api =
895 (const struct smbus_driver_api *)dev->api;
896
897 if (api->smbus_word_data_write == NULL) {
898 return -ENOSYS;
899 }
900
901 return api->smbus_word_data_write(dev, addr, cmd, word);
902}
903
920__syscall int smbus_word_data_read(const struct device *dev, uint16_t addr,
921 uint8_t cmd, uint16_t *word);
922
923static inline int z_impl_smbus_word_data_read(const struct device *dev,
924 uint16_t addr, uint8_t cmd,
925 uint16_t *word)
926{
927 const struct smbus_driver_api *api =
928 (const struct smbus_driver_api *)dev->api;
929
930 if (api->smbus_word_data_read == NULL) {
931 return -ENOSYS;
932 }
933
934 return api->smbus_word_data_read(dev, addr, cmd, word);
935}
936
955__syscall int smbus_pcall(const struct device *dev, uint16_t addr,
956 uint8_t cmd, uint16_t send_word, uint16_t *recv_word);
957
958static inline int z_impl_smbus_pcall(const struct device *dev,
959 uint16_t addr, uint8_t cmd,
960 uint16_t send_word, uint16_t *recv_word)
961{
962 const struct smbus_driver_api *api =
963 (const struct smbus_driver_api *)dev->api;
964
965 if (api->smbus_pcall == NULL) {
966 return -ENOSYS;
967 }
968
969 return api->smbus_pcall(dev, addr, cmd, send_word, recv_word);
970}
971
989__syscall int smbus_block_write(const struct device *dev, uint16_t addr,
991
992static inline int z_impl_smbus_block_write(const struct device *dev,
993 uint16_t addr, uint8_t cmd,
994 uint8_t count, uint8_t *buf)
995{
996 const struct smbus_driver_api *api =
997 (const struct smbus_driver_api *)dev->api;
998
999 if (api->smbus_block_write == NULL) {
1000 return -ENOSYS;
1001 }
1002
1003 if (count < 1 || count > SMBUS_BLOCK_BYTES_MAX) {
1004 return -EINVAL;
1005 }
1006
1007 return api->smbus_block_write(dev, addr, cmd, count, buf);
1008}
1009
1027__syscall int smbus_block_read(const struct device *dev, uint16_t addr,
1028 uint8_t cmd, uint8_t *count, uint8_t *buf);
1029
1030static inline int z_impl_smbus_block_read(const struct device *dev,
1031 uint16_t addr, uint8_t cmd,
1032 uint8_t *count, uint8_t *buf)
1033{
1034 const struct smbus_driver_api *api =
1035 (const struct smbus_driver_api *)dev->api;
1036
1037 if (api->smbus_block_read == NULL) {
1038 return -ENOSYS;
1039 }
1040
1041 return api->smbus_block_read(dev, addr, cmd, count, buf);
1042}
1043
1064__syscall int smbus_block_pcall(const struct device *dev,
1065 uint16_t addr, uint8_t cmd,
1066 uint8_t snd_count, uint8_t *snd_buf,
1067 uint8_t *rcv_count, uint8_t *rcv_buf);
1068
1069static inline int z_impl_smbus_block_pcall(const struct device *dev,
1070 uint16_t addr, uint8_t cmd,
1071 uint8_t snd_count, uint8_t *snd_buf,
1072 uint8_t *rcv_count, uint8_t *rcv_buf)
1073{
1074 const struct smbus_driver_api *api =
1075 (const struct smbus_driver_api *)dev->api;
1076
1077 if (api->smbus_block_pcall == NULL) {
1078 return -ENOSYS;
1079 }
1080
1081 return api->smbus_block_pcall(dev, addr, cmd, snd_count, snd_buf,
1082 rcv_count, rcv_buf);
1083}
1084
1085#ifdef __cplusplus
1086}
1087#endif
1088
1093#include <syscalls/smbus.h>
1094
1095#endif /* ZEPHYR_INCLUDE_DRIVERS_SMBUS_H_ */
ZTEST_BMEM int count
Definition: main.c:33
static ssize_t recv(int sock, void *buf, size_t max_len, int flags)
Definition: socket.h:744
static void cmd(uint32_t command)
Execute a display list command by co-processor engine.
Definition: ft8xx_reference_api.h:153
static void smbus_xfer_stats(const struct device *dev, uint8_t sent, uint8_t recv)
Updates the SMBus stats.
Definition: smbus.h:457
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
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
Definition: smbus.h:245
@ SMBUS_MSG_READ
Definition: smbus.h:247
#define CONTAINER_OF(ptr, type, field)
Get a pointer to a structure containing the element.
Definition: util.h:224
#define EINVAL
Definition: errno.h:61
#define ENOSYS
Definition: errno.h:83
state
Definition: parser_state.h:29
struct _snode sys_snode_t
Definition: slist.h:33
Statistics.
#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:353
Runtime device structure (in ROM) per driver instance.
Definition: device.h:380
const void * api
Definition: device.h:386
struct device_state * state
Definition: device.h:388
SMBus callback structure.
Definition: smbus.h:278
smbus_callback_handler_t handler
Definition: smbus.h:283
uint8_t addr
Definition: smbus.h:286
sys_snode_t node
Definition: smbus.h:280
Complete SMBus DT information.
Definition: smbus.h:295
uint16_t addr
Definition: smbus.h:297
const struct device * bus
Definition: smbus.h:296
static ZTEST_DMEM uint32_t send_buf[2]
Definition: test_msgq_attrs.c:10