smbus_target.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Tenstorrent AI ULC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef SMBUS_TARGET
#define SMBUS_TARGET
 
#include <stddef.h>
#include <stdint.h>

enum smbus_trans_type {
        SMBUS_TRANS_WRITE_BYTE,
        SMBUS_TRANS_READ_BYTE,
        SMBUS_TRANS_WRITE_WORD,
        SMBUS_TRANS_READ_WORD,
        SMBUS_TRANS_WRITE_BLOCK,
        SMBUS_TRANS_READ_BLOCK,
        SMBUS_TRANS_READ_WRITE_BLOCK,
};

typedef int32_t (*smbus_rcv_handler)(const uint8_t *data, uint8_t size);

typedef int32_t (*smbus_send_handler)(uint8_t *data, uint8_t *size);
 
struct smbus_cmd_def {
        enum smbus_trans_type trans_type;
        smbus_rcv_handler rcv_handler;
        smbus_send_handler send_handler;
        uint8_t pec: 1;
};

struct smbus_cmd_registration {
        uint8_t cmd;
        struct smbus_cmd_def def;
};

#define SMBUS_CMD_ENTRY(_cmd, _pec, _trans_type, _rcv, _send)                                      \
        {                                                                                          \
                .cmd = (_cmd),                                                                     \
                .def = {.pec = (_pec),                                                             \
                        .trans_type = (_trans_type),                                               \
                        .rcv_handler = (_rcv),                                                     \
                        .send_handler = (_send)},                                                  \
        }

#define SMBUS_CMD_HANDLER_FIELDS_WRITE(_func) .rcv_handler = (_func), .send_handler = NULL

#define SMBUS_CMD_HANDLER_FIELDS_READ(_func) .rcv_handler = NULL, .send_handler = (_func)

#define SMBUS_CMD_GEN_ENTRY(_cmd, _pec, _dir, _kind, _func)                                        \
        {                                                                                          \
                .cmd = (_cmd),                                                                     \
                .def = {.pec = (_pec),                                                             \
                        .trans_type = SMBUS_TRANS_##_dir##_##_kind,                                \
                        SMBUS_CMD_HANDLER_FIELDS_##_dir(_func)},                                   \
        }

#define SMBUS_CMD_BLOCK_RD_ENTRY(_cmd, _pec, _send)                                                \
        SMBUS_CMD_GEN_ENTRY(_cmd, _pec, READ, BLOCK, _send)

#define SMBUS_CMD_BLOCK_WR_ENTRY(_cmd, _pec, _rcv)                                                 \
        SMBUS_CMD_GEN_ENTRY(_cmd, _pec, WRITE, BLOCK, _rcv)

#define SMBUS_CMD_READ_BYTE_ENTRY(_cmd, _pec, _send)                                               \
        SMBUS_CMD_GEN_ENTRY(_cmd, _pec, READ, BYTE, _send)

#define SMBUS_CMD_WRITE_BYTE_ENTRY(_cmd, _pec, _rcv)                                               \
        SMBUS_CMD_GEN_ENTRY(_cmd, _pec, WRITE, BYTE, _rcv)

#define SMBUS_CMD_READ_WORD_ENTRY(_cmd, _pec, _send)                                               \
        SMBUS_CMD_GEN_ENTRY(_cmd, _pec, READ, WORD, _send)

#define SMBUS_CMD_WRITE_WORD_ENTRY(_cmd, _pec, _rcv)                                               \
        SMBUS_CMD_GEN_ENTRY(_cmd, _pec, WRITE, WORD, _rcv)

#define SMBUS_CMD_BLOCK_WR_BLOCK_RD_ENTRY(_cmd, _pec, _rcv, _send)                                 \
        SMBUS_CMD_ENTRY(_cmd, _pec, SMBUS_TRANS_READ_WRITE_BLOCK, _rcv, _send)

int32_t smbus_target_register_cmd(const struct device *dev, uint8_t cmd_id,
                                  const struct smbus_cmd_def *smbus_cmd);

int32_t smbus_target_register_cmds(const struct device *dev,
                                   const struct smbus_cmd_registration *cmds, size_t num_cmds);

uint32_t smbus_target_get_error_count(const struct device *dev);
#endif