get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/130940/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 130940,
    "url": "https://patches.dpdk.org/api/patches/130940/?format=api",
    "web_url": "https://patches.dpdk.org/project/dpdk/patch/20230831095650.219964-7-wanry@3snic.com/",
    "project": {
        "id": 1,
        "url": "https://patches.dpdk.org/api/projects/1/?format=api",
        "name": "DPDK",
        "link_name": "dpdk",
        "list_id": "dev.dpdk.org",
        "list_email": "dev@dpdk.org",
        "web_url": "http://core.dpdk.org",
        "scm_url": "git://dpdk.org/dpdk",
        "webscm_url": "http://git.dpdk.org/dpdk",
        "list_archive_url": "https://inbox.dpdk.org/dev",
        "list_archive_url_format": "https://inbox.dpdk.org/dev/{}",
        "commit_url_format": ""
    },
    "msgid": "<20230831095650.219964-7-wanry@3snic.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20230831095650.219964-7-wanry@3snic.com",
    "date": "2023-08-31T09:56:24",
    "name": "[v2,06/32] net/sssnic/base: add message definition and utility",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "b1f88cefe3f5b348c061f02f12b8702df3b6178a",
    "submitter": {
        "id": 3119,
        "url": "https://patches.dpdk.org/api/people/3119/?format=api",
        "name": "Renyong Wan",
        "email": "wanry@3snic.com"
    },
    "delegate": {
        "id": 1,
        "url": "https://patches.dpdk.org/api/users/1/?format=api",
        "username": "tmonjalo",
        "first_name": "Thomas",
        "last_name": "Monjalon",
        "email": "thomas@monjalon.net"
    },
    "mbox": "https://patches.dpdk.org/project/dpdk/patch/20230831095650.219964-7-wanry@3snic.com/mbox/",
    "series": [
        {
            "id": 29383,
            "url": "https://patches.dpdk.org/api/series/29383/?format=api",
            "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=29383",
            "date": "2023-08-31T09:56:18",
            "name": "Introduce sssnic PMD for 3SNIC's 9x0 serials Ethernet adapters",
            "version": 2,
            "mbox": "https://patches.dpdk.org/series/29383/mbox/"
        }
    ],
    "comments": "https://patches.dpdk.org/api/patches/130940/comments/",
    "check": "warning",
    "checks": "https://patches.dpdk.org/api/patches/130940/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<dev-bounces@dpdk.org>",
        "X-Original-To": "patchwork@inbox.dpdk.org",
        "Delivered-To": "patchwork@inbox.dpdk.org",
        "Received": [
            "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id E885941FDA;\n\tThu, 31 Aug 2023 11:58:42 +0200 (CEST)",
            "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id CC13E402A6;\n\tThu, 31 Aug 2023 11:58:07 +0200 (CEST)",
            "from VLXDG1SPAM1.ramaxel.com (email.unionmem.com [221.4.138.186])\n by mails.dpdk.org (Postfix) with ESMTP id 4CEFC4029F\n for <dev@dpdk.org>; Thu, 31 Aug 2023 11:58:03 +0200 (CEST)",
            "from V12DG1MBS03.ramaxel.local ([172.26.18.33])\n by VLXDG1SPAM1.ramaxel.com with ESMTP id 37V9ve5Y064322;\n Thu, 31 Aug 2023 17:57:40 +0800 (GMT-8)\n (envelope-from wanry@3snic.com)",
            "from localhost.localdomain (10.64.136.151) by\n V12DG1MBS03.ramaxel.local (172.26.18.33) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id\n 15.1.2375.17; Thu, 31 Aug 2023 17:57:39 +0800"
        ],
        "From": "<wanry@3snic.com>",
        "To": "<dev@dpdk.org>",
        "CC": "<ferruh.yigit@amd.com>, Renyong Wan <wanry@3snic.com>, Steven Song\n <steven.song@3snic.com>",
        "Subject": "[PATCH v2 06/32] net/sssnic/base: add message definition and utility",
        "Date": "Thu, 31 Aug 2023 17:56:24 +0800",
        "Message-ID": "<20230831095650.219964-7-wanry@3snic.com>",
        "X-Mailer": "git-send-email 2.25.1",
        "In-Reply-To": "<20230831095650.219964-1-wanry@3snic.com>",
        "References": "<20230831095650.219964-1-wanry@3snic.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "7bit",
        "Content-Type": "text/plain",
        "X-Originating-IP": "[10.64.136.151]",
        "X-ClientProxiedBy": "V12DG1MBS03.ramaxel.local (172.26.18.33) To\n V12DG1MBS03.ramaxel.local (172.26.18.33)",
        "X-DNSRBL": "",
        "X-SPAM-SOURCE-CHECK": "pass",
        "X-MAIL": "VLXDG1SPAM1.ramaxel.com 37V9ve5Y064322",
        "X-BeenThere": "dev@dpdk.org",
        "X-Mailman-Version": "2.1.29",
        "Precedence": "list",
        "List-Id": "DPDK patches and discussions <dev.dpdk.org>",
        "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>",
        "List-Archive": "<http://mails.dpdk.org/archives/dev/>",
        "List-Post": "<mailto:dev@dpdk.org>",
        "List-Help": "<mailto:dev-request@dpdk.org?subject=help>",
        "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>",
        "Errors-To": "dev-bounces@dpdk.org"
    },
    "content": "From: Renyong Wan <wanry@3snic.com>\n\nsssnic message is used to encapsulate sssnic command for transmission\nbetween driver and firmware. sssnic message is sent by driver via mail\nbox and is received by driver via event queue.\n\nSigned-off-by: Steven Song <steven.song@3snic.com>\nSigned-off-by: Renyong Wan <wanry@3snic.com>\n---\nv2:\n* Removed error.h from including files.\n---\n drivers/net/sssnic/base/meson.build     |   3 +-\n drivers/net/sssnic/base/sssnic_eventq.c |  29 +++\n drivers/net/sssnic/base/sssnic_hw.c     |  15 +-\n drivers/net/sssnic/base/sssnic_hw.h     |   2 +\n drivers/net/sssnic/base/sssnic_msg.c    | 254 ++++++++++++++++++++++++\n drivers/net/sssnic/base/sssnic_msg.h    | 166 ++++++++++++++++\n 6 files changed, 467 insertions(+), 2 deletions(-)\n create mode 100644 drivers/net/sssnic/base/sssnic_msg.c\n create mode 100644 drivers/net/sssnic/base/sssnic_msg.h",
    "diff": "diff --git a/drivers/net/sssnic/base/meson.build b/drivers/net/sssnic/base/meson.build\nindex 7758faa482..dd4dd08fc1 100644\n--- a/drivers/net/sssnic/base/meson.build\n+++ b/drivers/net/sssnic/base/meson.build\n@@ -3,7 +3,8 @@\n \n sources = [\n         'sssnic_hw.c',\n-        'sssnic_eventq.c'\n+        'sssnic_eventq.c',\n+        'sssnic_msg.c',\n ]\n \n c_args = cflags\ndiff --git a/drivers/net/sssnic/base/sssnic_eventq.c b/drivers/net/sssnic/base/sssnic_eventq.c\nindex a479bdff35..f6a343f0e8 100644\n--- a/drivers/net/sssnic/base/sssnic_eventq.c\n+++ b/drivers/net/sssnic/base/sssnic_eventq.c\n@@ -14,6 +14,7 @@\n #include \"../sssnic_log.h\"\n #include \"sssnic_hw.h\"\n #include \"sssnic_reg.h\"\n+#include \"sssnic_msg.h\"\n #include \"sssnic_eventq.h\"\n \n #define SSSNIC_EVENTQ_DEF_DEPTH 64\n@@ -184,6 +185,32 @@ sssnic_eventq_ci_update(struct sssnic_eventq *eq, int informed)\n \tsssnic_eventq_reg_write(eq, SSSNIC_EVENTQ_CI_CTRL_REG, reg.u32);\n }\n \n+static int\n+sssnic_event_default_handler_func(struct sssnic_eventq *eq,\n+\tstruct sssnic_event *ev, __rte_unused void *data)\n+{\n+\tstruct sssnic_hw *hw;\n+\tint ret;\n+\n+\thw = eq->hw;\n+\tret = sssnic_msg_rx_handle(hw, (struct sssnic_msg_hdr *)(ev->data));\n+\tif (ret != SSSNIC_MSG_DONE)\n+\t\treturn -1;\n+\n+\treturn SSSNIC_EVENT_DONE;\n+}\n+\n+static void\n+sssnic_eventq_handlers_init(struct sssnic_eventq *eq)\n+{\n+\tint i;\n+\n+\tfor (i = SSSNIC_EVENT_CODE_MIN; i <= SSSNIC_EVENT_CODE_MAX; i++) {\n+\t\teq->handlers[i].func = sssnic_event_default_handler_func;\n+\t\teq->handlers[i].data = NULL;\n+\t}\n+}\n+\n static int\n sssnic_eventq_init(struct sssnic_hw *hw, struct sssnic_eventq *eq, uint16_t qid)\n {\n@@ -230,6 +257,8 @@ sssnic_eventq_init(struct sssnic_hw *hw, struct sssnic_eventq *eq, uint16_t qid)\n \t\tPMD_DRV_LOG(ERR, \"Failed to setup eventq pages!\");\n \t\treturn ret;\n \t}\n+\n+\tsssnic_eventq_handlers_init(eq);\n \tsssnic_eventq_ctrl_setup(eq);\n \tsssnic_eventq_ci_update(eq, 1);\n \tif (qid == 0)\ndiff --git a/drivers/net/sssnic/base/sssnic_hw.c b/drivers/net/sssnic/base/sssnic_hw.c\nindex 44e04486a5..387c823c7e 100644\n--- a/drivers/net/sssnic/base/sssnic_hw.c\n+++ b/drivers/net/sssnic/base/sssnic_hw.c\n@@ -10,6 +10,7 @@\n #include \"sssnic_hw.h\"\n #include \"sssnic_reg.h\"\n #include \"sssnic_eventq.h\"\n+#include \"sssnic_msg.h\"\n \n static int\n wait_for_sssnic_hw_ready(struct sssnic_hw *hw)\n@@ -197,18 +198,30 @@ sssnic_hw_init(struct sssnic_hw *hw)\n \t\treturn ret;\n \t}\n \n+\tret = sssnic_msg_inbox_init(hw);\n+\tif (ret) {\n+\t\tPMD_DRV_LOG(ERR, \"Failed to initialize message inbox.\");\n+\t\treturn ret;\n+\t}\n+\n \tret = sssnic_eventq_all_init(hw);\n \tif (ret != 0) {\n \t\tPMD_DRV_LOG(ERR, \"Failed to initialize event queues\");\n-\t\treturn ret;\n+\t\tgoto eventq_init_fail;\n \t}\n \n \treturn -EINVAL;\n+\n+eventq_init_fail:\n+\tsssnic_msg_inbox_shutdown(hw);\n+\treturn ret;\n }\n \n void\n sssnic_hw_shutdown(struct sssnic_hw *hw)\n {\n \tPMD_INIT_FUNC_TRACE();\n+\n \tsssnic_eventq_all_shutdown(hw);\n+\tsssnic_msg_inbox_shutdown(hw);\n }\ndiff --git a/drivers/net/sssnic/base/sssnic_hw.h b/drivers/net/sssnic/base/sssnic_hw.h\nindex 6caf3a6d66..38fb9ac1ac 100644\n--- a/drivers/net/sssnic/base/sssnic_hw.h\n+++ b/drivers/net/sssnic/base/sssnic_hw.h\n@@ -52,11 +52,13 @@ struct sssnic_hw {\n \tuint8_t *db_mem_len;\n \tstruct sssnic_hw_attr attr;\n \tstruct sssnic_eventq *eventqs;\n+\tstruct sssnic_msg_inbox *msg_inbox;\n \tuint8_t num_eventqs;\n \tuint16_t eth_port_id;\n };\n \n #define SSSNIC_ETH_PORT_ID(hw) ((hw)->eth_port_id)\n+#define SSSNIC_MPU_FUNC_IDX 0x1fff\n \n int sssnic_hw_init(struct sssnic_hw *hw);\n void sssnic_hw_shutdown(struct sssnic_hw *hw);\ndiff --git a/drivers/net/sssnic/base/sssnic_msg.c b/drivers/net/sssnic/base/sssnic_msg.c\nnew file mode 100644\nindex 0000000000..4b98fee75b\n--- /dev/null\n+++ b/drivers/net/sssnic/base/sssnic_msg.c\n@@ -0,0 +1,254 @@\n+/* SPDX-License-Identifier: BSD-3-Clause\n+ * Copyright(c) 2018-2022 Shenzhen 3SNIC Information Technology Co., Ltd.\n+ */\n+\n+#include <rte_common.h>\n+#include <rte_malloc.h>\n+#include <rte_mempool.h>\n+#include <rte_memcpy.h>\n+\n+#include \"../sssnic_log.h\"\n+#include \"sssnic_hw.h\"\n+#include \"sssnic_msg.h\"\n+\n+/* Receive message segment based on message header\n+ * @param msghdr\n+ *\tmessage header\n+ * @param msg\n+ *\tmessage where segment store\n+ * @return\n+ *\tSSSNIC_MSG_REJECT - Message segment was not received because of bad\n+ *                          parameter of message header.\n+ *\tSSSNIC_MSG_ACCEPT - Message segment was received.\n+ *\tSSSNIC_MSG_DONE   - The last message segment was received.\n+ */\n+static int\n+sssnic_msg_rx_seg(struct sssnic_msg_hdr *msghdr, struct sssnic_msg *msg)\n+{\n+\tif (msghdr->seg_id > SSSNIC_MSG_MAX_SEG_ID ||\n+\t\tmsghdr->seg_len > SSSNIC_MSG_MAX_SEG_SIZE) {\n+\t\tPMD_DRV_LOG(ERR,\n+\t\t\t\"Bad segment id or segment size of message header\");\n+\t\treturn SSSNIC_MSG_REJECT;\n+\t}\n+\n+\tif (msghdr->seg_id == 0) {\n+\t\tmsg->command = msghdr->command;\n+\t\tmsg->type = msghdr->type;\n+\t\tmsg->module = msghdr->module;\n+\t\tmsg->id = msghdr->id;\n+\t} else {\n+\t\tif (msghdr->seg_id != (msg->seg + 1) || msghdr->id != msg->id ||\n+\t\t\tmsghdr->module != msg->module ||\n+\t\t\tmsghdr->command != msg->command) {\n+\t\t\tPMD_DRV_LOG(ERR, \"Bad parameters of message header\");\n+\t\t\treturn SSSNIC_MSG_REJECT;\n+\t\t}\n+\t}\n+\trte_memcpy(msg->data_buf + (SSSNIC_MSG_MAX_SEG_SIZE * msghdr->seg_id),\n+\t\tSSSNIC_MSG_DATA(msghdr), msghdr->seg_len);\n+\n+\tif (!msghdr->last_seg) {\n+\t\tmsg->seg = msghdr->seg_id;\n+\t\treturn SSSNIC_MSG_ACCEPT;\n+\t}\n+\n+\tmsg->ack = !msghdr->no_response;\n+\tmsg->status = msghdr->status;\n+\tmsg->data_len = msghdr->length;\n+\tmsg->func = msghdr->function;\n+\tmsg->seg = SSSNIC_MSG_MAX_SEG_ID;\n+\n+\treturn SSSNIC_MSG_DONE;\n+}\n+\n+static int\n+sssnic_msg_buf_alloc(struct sssnic_msg *msg, size_t size)\n+{\n+\tmsg->data_buf = rte_zmalloc(\"sssnic_msg_data\", size, 1);\n+\tif (msg->data_buf == NULL) {\n+\t\tPMD_DRV_LOG(ERR, \"Could not all message data buffer!\");\n+\t\treturn -ENOMEM;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+static void\n+sssnic_msg_buf_free(struct sssnic_msg *msg)\n+{\n+\trte_free(msg->data_buf);\n+}\n+\n+int\n+sssnic_msg_rx_handle(struct sssnic_hw *hw, struct sssnic_msg_hdr *msghdr)\n+{\n+\tstruct sssnic_msg *msg;\n+\tstruct sssnic_msg_handler *msg_handler;\n+\tint msg_src;\n+\tint msg_chan;\n+\tint msg_type;\n+\tint ret;\n+\n+\tmsg_src = SSSNIC_MSG_SRC(msghdr->function);\n+\tmsg_chan = msghdr->channel;\n+\tmsg_type = msghdr->type;\n+\tmsg = SSSNIC_MSG_LOCATE(hw, msg_chan, msg_type, msg_src);\n+\n+\tret = sssnic_msg_rx_seg(msghdr, msg);\n+\tif (ret != SSSNIC_MSG_DONE)\n+\t\treturn ret;\n+\n+\tmsg_handler = SSSNIC_MSG_HANDLER(hw, msg_chan, msg_type);\n+\tif (msg_handler->func == NULL) {\n+\t\tPMD_DRV_LOG(NOTICE,\n+\t\t\t\"No message handler, message channel:%d, type:%d.\",\n+\t\t\tmsg_chan, msg_type);\n+\t\treturn SSSNIC_MSG_REJECT;\n+\t}\n+\tret = msg_handler->func(msg, msg_chan, msg_handler->priv);\n+\n+\treturn ret;\n+}\n+\n+int\n+sssnic_msg_rx_handler_register(struct sssnic_hw *hw,\n+\tenum sssnic_msg_chann_id chann_id, enum sssnic_msg_type msg_type,\n+\tsssnic_msg_handler_func_t *func, void *priv)\n+{\n+\tstruct sssnic_msg_handler *msg_handler;\n+\n+\tif (chann_id >= SSSNIC_MSG_CHAN_COUNT ||\n+\t\tmsg_type >= SSSNIC_MSG_TYPE_CONUT || func == NULL) {\n+\t\tPMD_DRV_LOG(ERR,\n+\t\t\t\"Bad parameters for register rx message handler.\");\n+\t\treturn -EINVAL;\n+\t}\n+\n+\tmsg_handler = SSSNIC_MSG_HANDLER(hw, chann_id, msg_type);\n+\tif (msg_handler->func != NULL)\n+\t\tPMD_DRV_LOG(WARNING,\n+\t\t\t\"RX message handler has existed, chann_id:%u, msg_type:%u\",\n+\t\t\tchann_id, msg_type);\n+\n+\tmsg_handler->func = func;\n+\tmsg_handler->priv = priv;\n+\n+\treturn 0;\n+}\n+\n+static int\n+sssnic_msg_channel_init(struct sssnic_hw *hw, struct sssnic_msg_channel *chan)\n+{\n+\tstruct sssnic_msg *msg;\n+\tint i;\n+\tint ret;\n+\n+\tPMD_INIT_FUNC_TRACE();\n+\n+\tfor (i = 0; i < SSSNIC_MSG_TYPE_CONUT; i++) {\n+\t\tmsg = &chan->msg[i][SSSNIC_MSG_SRC_MPU];\n+\t\tret = sssnic_msg_buf_alloc(msg, SSSNIC_MSG_BUF_SIZE);\n+\t\tif (ret) {\n+\t\t\tPMD_DRV_LOG(ERR,\n+\t\t\t\t\"Could not alloc MPU message buf for message inbox channel %d of sssnic%u.\",\n+\t\t\t\tSSSNIC_ETH_PORT_ID(hw), chan->id);\n+\t\t\tgoto msg_buf_alloc_fail;\n+\t\t}\n+\t\tmsg = &chan->msg[i][SSSNIC_MSG_SRC_PF];\n+\t\tret = sssnic_msg_buf_alloc(msg, SSSNIC_MSG_BUF_SIZE);\n+\t\tif (ret) {\n+\t\t\tPMD_DRV_LOG(ERR,\n+\t\t\t\t\"Could not alloc PF message buf for message inbox channel %d of sssnic%u.\",\n+\t\t\t\tSSSNIC_ETH_PORT_ID(hw), chan->id);\n+\t\t\tmsg = &chan->msg[i][SSSNIC_MSG_SRC_MPU];\n+\t\t\tsssnic_msg_buf_free(msg);\n+\t\t\tgoto msg_buf_alloc_fail;\n+\t\t}\n+\t}\n+\n+\treturn 0;\n+\n+msg_buf_alloc_fail:\n+\twhile (i--) {\n+\t\tmsg = &chan->msg[i][SSSNIC_MSG_SRC_MPU];\n+\t\tsssnic_msg_buf_free(msg);\n+\t\tmsg = &chan->msg[i][SSSNIC_MSG_SRC_PF];\n+\t\tsssnic_msg_buf_free(msg);\n+\t}\n+\treturn ret;\n+}\n+\n+static void\n+sssnic_msg_channel_shutdown(__rte_unused struct sssnic_hw *hw,\n+\tstruct sssnic_msg_channel *chan)\n+{\n+\tstruct sssnic_msg *msg;\n+\tint i;\n+\n+\tPMD_INIT_FUNC_TRACE();\n+\n+\tfor (i = 0; i < SSSNIC_MSG_TYPE_CONUT; i++) {\n+\t\tmsg = &chan->msg[i][SSSNIC_MSG_SRC_MPU];\n+\t\tsssnic_msg_buf_free(msg);\n+\t\tmsg = &chan->msg[i][SSSNIC_MSG_SRC_PF];\n+\t\tsssnic_msg_buf_free(msg);\n+\t}\n+}\n+\n+int\n+sssnic_msg_inbox_init(struct sssnic_hw *hw)\n+{\n+\tstruct sssnic_msg_inbox *inbox;\n+\tstruct sssnic_msg_channel *chan;\n+\tint i;\n+\tint ret;\n+\n+\tPMD_INIT_FUNC_TRACE();\n+\n+\tinbox = rte_zmalloc(NULL, sizeof(struct sssnic_msg_inbox), 1);\n+\tif (inbox == NULL) {\n+\t\tPMD_DRV_LOG(ERR, \"Could not alloc memory for message inbox\");\n+\t\treturn -ENOMEM;\n+\t}\n+\n+\tinbox->hw = hw;\n+\thw->msg_inbox = inbox;\n+\n+\tfor (i = 0; i < SSSNIC_MSG_CHAN_COUNT; i++) {\n+\t\tchan = &inbox->channel[i];\n+\t\tret = sssnic_msg_channel_init(hw, chan);\n+\t\tif (ret) {\n+\t\t\tPMD_DRV_LOG(ERR,\n+\t\t\t\t\"Failed to initialize channel%u of message inbox\",\n+\t\t\t\ti);\n+\t\t\tgoto init_msg_channel_fail;\n+\t\t}\n+\t\tchan->id = i;\n+\t}\n+\n+\treturn 0;\n+\n+init_msg_channel_fail:\n+\twhile (i--) {\n+\t\tchan = &inbox->channel[i];\n+\t\tsssnic_msg_channel_shutdown(hw, chan);\n+\t}\n+\trte_free(inbox);\n+\treturn ret;\n+}\n+\n+void\n+sssnic_msg_inbox_shutdown(struct sssnic_hw *hw)\n+{\n+\tstruct sssnic_msg_channel *chan;\n+\tint i;\n+\n+\tPMD_INIT_FUNC_TRACE();\n+\n+\tfor (i = 0; i < SSSNIC_MSG_CHAN_COUNT; i++) {\n+\t\tchan = &hw->msg_inbox->channel[i];\n+\t\tsssnic_msg_channel_shutdown(hw, chan);\n+\t}\n+\trte_free(hw->msg_inbox);\n+}\ndiff --git a/drivers/net/sssnic/base/sssnic_msg.h b/drivers/net/sssnic/base/sssnic_msg.h\nnew file mode 100644\nindex 0000000000..6580f4bb37\n--- /dev/null\n+++ b/drivers/net/sssnic/base/sssnic_msg.h\n@@ -0,0 +1,166 @@\n+/* SPDX-License-Identifier: BSD-3-Clause\n+ * Copyright(c) 2018-2022 Shenzhen 3SNIC Information Technology Co., Ltd.\n+ */\n+\n+#ifndef _SSSNIC_MSG_H_\n+#define _SSSNIC_MSG_H_\n+\n+#include <string.h>\n+\n+enum sssnic_msg_chann_id {\n+\tSSSNIC_MSG_CHAN_MPU = 0, /* Message comes from MPU directly */\n+\tSSSNIC_MSG_CHAN_MBOX = 1, /* Message comes from MBOX */\n+\tSSSNIC_MSG_CHAN_COUNT = 2,\n+};\n+\n+enum sssnic_msg_src {\n+\tSSSNIC_MSG_SRC_MPU, /* mbox message from MPU */\n+\tSSSNIC_MSG_SRC_PF, /* mbox message from PF */\n+\tSSSNIC_MSG_SRC_COUNT,\n+};\n+\n+#define SSSNIC_MSG_SRC(func_id)                                                \\\n+\t(((func_id) == SSSNIC_MPU_FUNC_IDX) ? SSSNIC_MSG_SRC_MPU :             \\\n+\t\t\t\t\t\t    SSSNIC_MSG_SRC_PF)\n+\n+enum sssnic_msg_type {\n+\tSSSNIC_MSG_TYPE_REQ, /* Request message*/\n+\tSSSNIC_MSG_TYPE_RESP, /* Response message */\n+\tSSSNIC_MSG_TYPE_CONUT,\n+};\n+\n+#define SSSNIC_MSG_TRANS_MODE_DMA 1\n+#define SSSNIC_MSG_TRANS_MODE_INLINE 0\n+\n+/* hardware format of sssnic message header */\n+struct sssnic_msg_hdr {\n+\tunion {\n+\t\tuint64_t u64;\n+\t\tstruct {\n+\t\t\tuint32_t dw0;\n+\t\t\tuint32_t dw1;\n+\t\t};\n+\t\tstruct {\n+\t\t\t/* Id of the function the message comes from or send to */\n+\t\t\tuint64_t function : 13;\n+\t\t\t/* indicate the result of command */\n+\t\t\tuint64_t status : 2;\n+\t\t\t/* Mbox channel that message receive from or send to */\n+\t\t\tuint64_t channel : 1;\n+\t\t\t/* ID of the EventQ that response message is informed by */\n+\t\t\tuint64_t eventq : 2;\n+\t\t\t/* Message ID */\n+\t\t\tuint64_t id : 4;\n+\t\t\t/* Command ID of the message */\n+\t\t\tuint64_t command : 10;\n+\t\t\t/* total length of message data */\n+\t\t\tuint64_t length : 11;\n+\t\t\t/* Module of message comes from or send to */\n+\t\t\tuint64_t module : 5;\n+\t\t\t/* Length of this data segment */\n+\t\t\tuint64_t seg_len : 6;\n+\t\t\t/* needless response indication */\n+\t\t\tuint64_t no_response : 1;\n+\t\t\t/* Message data transmission mode, 0: inline 1:dma */\n+\t\t\tuint64_t trans_mode : 1;\n+\t\t\t/* Segment sequence of message data */\n+\t\t\tuint64_t seg_id : 6;\n+\t\t\t/* Last data segment indication, 1: Last segment */\n+\t\t\tuint64_t last_seg : 1;\n+\t\t\t/* Message type, see sssnic_mbox_msg_type */\n+\t\t\tuint64_t type : 1;\n+\t\t};\n+\t};\n+};\n+#define SSSNIC_MSG_HDR_SIZE sizeof(struct sssnic_msg_hdr)\n+#define SSSNIC_MSG_DATA(hdr) (((uint8_t *)hdr) + SSSNIC_MSG_HDR_SIZE)\n+\n+#define SSSNIC_MSG_BUF_SIZE 2048UL\n+#define SSSNIC_MSG_MAX_SEG_SIZE 48\n+#define SSSNIC_MSG_MIN_SGE_ID 0\n+#define SSSNIC_MSG_MAX_SEG_ID 42\n+#define SSSNIC_MSG_MAX_DATA_SIZE (SSSNIC_MSG_BUF_SIZE - SSSNIC_MSG_HDR_SIZE)\n+\n+struct sssnic_msg {\n+\t/* message command ID */\n+\tuint16_t command;\n+\t/* function id of that message send to or receive from */\n+\tuint16_t func;\n+\t/* module id of that message send to or receive from */\n+\tuint32_t module;\n+\t/* message is request or response*/\n+\tenum sssnic_msg_type type;\n+\t/* message data */\n+\tuint8_t *data_buf;\n+\t/* data length */\n+\tuint32_t data_len;\n+\t/* need response indication */\n+\tuint8_t ack;\n+\t/* the id of last received segment*/\n+\tuint8_t seg;\n+\t/* indicate the result of request in response message, request failed if not 0 */\n+\tuint8_t status;\n+\t/* generated by sender if dir == SSSNIC_MSG_TYPE_REQ */\n+\tuint8_t id;\n+};\n+\n+#define SSSNIC_MSG_REJECT -1\n+#define SSSNIC_MSG_ACCEPT 0\n+#define SSSNIC_MSG_DONE 1\n+\n+/* sssnic message handler function\n+ * @return\n+ *   SSSNIC_MSG_REJECT - Message failed to handle\n+ *   SSSNIC_MSG_DONE   - Message succeed to handle\n+ */\n+typedef int sssnic_msg_handler_func_t(struct sssnic_msg *msg,\n+\tenum sssnic_msg_chann_id chan_id, void *priv);\n+\n+struct sssnic_msg_handler {\n+\tsssnic_msg_handler_func_t *func;\n+\tvoid *priv;\n+};\n+\n+struct sssnic_msg_channel {\n+\tenum sssnic_msg_chann_id id;\n+\tstruct sssnic_msg msg[SSSNIC_MSG_TYPE_CONUT][SSSNIC_MSG_SRC_COUNT];\n+\tstruct sssnic_msg_handler handler[SSSNIC_MSG_TYPE_CONUT];\n+};\n+\n+struct sssnic_msg_inbox {\n+\tstruct sssnic_hw *hw;\n+\tstruct sssnic_msg_channel channel[SSSNIC_MSG_CHAN_COUNT];\n+};\n+\n+#define SSSNIC_MSG_INBOX(hw) ((hw)->msg_inbox)\n+#define SSSNIC_MSG_CHANNEL(hw, chann_id)                                       \\\n+\t(&(SSSNIC_MSG_INBOX(hw)->channel[chann_id]))\n+#define SSSNIC_MSG_LOCATE(hw, chann_id, type, src)                             \\\n+\t(&SSSNIC_MSG_CHANNEL(hw, chann_id)->msg[type][src])\n+#define SSSNIC_MSG_HANDLER(hw, chann_id, type)                                 \\\n+\t(&SSSNIC_MSG_CHANNEL(hw, chann_id)->handler[type])\n+\n+static inline void\n+sssnic_msg_init(struct sssnic_msg *msg, uint8_t *data, uint32_t data_len,\n+\tuint16_t command, uint16_t func, uint32_t module,\n+\tenum sssnic_msg_type type)\n+{\n+\tmemset(msg, 0, sizeof(struct sssnic_msg));\n+\tmsg->data_buf = data;\n+\tmsg->data_len = data_len;\n+\tmsg->command = command;\n+\tmsg->module = module;\n+\tmsg->func = func;\n+\tmsg->type = type;\n+}\n+\n+int sssnic_msg_rx_handler_register(struct sssnic_hw *hw,\n+\tenum sssnic_msg_chann_id chann_id, enum sssnic_msg_type msg_type,\n+\tsssnic_msg_handler_func_t *func, void *priv);\n+int sssnic_msg_rx_handle(struct sssnic_hw *hw, struct sssnic_msg_hdr *msghdr);\n+int sssnic_msg_inbox_init(struct sssnic_hw *hw);\n+void sssnic_msg_inbox_shutdown(struct sssnic_hw *hw);\n+int sssnic_msg_rx(struct sssnic_msg_hdr *msghdr, uint16_t max_seg_len,\n+\tuint16_t max_seg_id, struct sssnic_msg *msg);\n+\n+#endif /* _SSSNIC_MSG_H_ */\n",
    "prefixes": [
        "v2",
        "06/32"
    ]
}