Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 1 | /* |
Kristofer Jonsson | b42bc0b | 2023-01-04 17:09:28 +0100 | [diff] [blame] | 2 | * Copyright 2020-2023 Arm Limited and/or its affiliates |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 3 | * |
| 4 | * This program is free software and is provided to you under the terms of the |
| 5 | * GNU General Public License version 2 as published by the Free Software |
| 6 | * Foundation, and any use by you of this program is subject to the terms |
| 7 | * of such GNU licence. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, you can access it online at |
| 16 | * http://www.gnu.org/licenses/gpl-2.0.html. |
| 17 | * |
| 18 | * SPDX-License-Identifier: GPL-2.0-only |
| 19 | */ |
| 20 | |
| 21 | #ifndef ETHOSU_MAILBOX_H |
| 22 | #define ETHOSU_MAILBOX_H |
| 23 | |
| 24 | /**************************************************************************** |
| 25 | * Includes |
| 26 | ****************************************************************************/ |
Kristofer Jonsson | d779a08 | 2023-01-04 17:09:47 +0100 | [diff] [blame] | 27 | #include "ethosu_core_rpmsg.h" |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 28 | |
| 29 | #include <linux/types.h> |
| 30 | #include <linux/mailbox_client.h> |
| 31 | #include <linux/workqueue.h> |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 32 | #include <linux/idr.h> |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 33 | |
| 34 | /**************************************************************************** |
| 35 | * Types |
| 36 | ****************************************************************************/ |
| 37 | |
| 38 | struct device; |
| 39 | struct ethosu_buffer; |
| 40 | struct ethosu_device; |
| 41 | struct ethosu_core_msg; |
| 42 | struct ethosu_core_queue; |
| 43 | struct resource; |
| 44 | |
| 45 | typedef void (*ethosu_mailbox_cb)(void *user_arg); |
| 46 | |
| 47 | struct ethosu_mailbox { |
Kristofer Jonsson | d779a08 | 2023-01-04 17:09:47 +0100 | [diff] [blame] | 48 | struct device *dev; |
| 49 | struct rpmsg_endpoint *ept; |
| 50 | struct idr msg_idr; |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 51 | }; |
| 52 | |
Mikael Olsson | 529cfad | 2023-06-14 17:14:14 +0200 | [diff] [blame] | 53 | /** |
| 54 | * struct ethosu_mailbox_msg - Mailbox message |
| 55 | * @id: Message id |
| 56 | * @type: Message request type |
| 57 | * @fail: Message failure callback |
| 58 | * |
| 59 | * The fail callback will be called with the device mutex locked |
| 60 | */ |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 61 | struct ethosu_mailbox_msg { |
Mikael Olsson | 09965b0 | 2023-06-13 12:17:04 +0200 | [diff] [blame] | 62 | int id; |
| 63 | uint32_t type; |
| 64 | void (*fail)(struct ethosu_mailbox_msg *msg); |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 65 | }; |
| 66 | |
| 67 | /**************************************************************************** |
| 68 | * Functions |
| 69 | ****************************************************************************/ |
| 70 | |
| 71 | /** |
| 72 | * ethosu_mailbox_init() - Initialize mailbox |
| 73 | * |
| 74 | * Return: 0 on success, else error code. |
| 75 | */ |
| 76 | int ethosu_mailbox_init(struct ethosu_mailbox *mbox, |
| 77 | struct device *dev, |
Kristofer Jonsson | d779a08 | 2023-01-04 17:09:47 +0100 | [diff] [blame] | 78 | struct rpmsg_endpoint *ept); |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 79 | |
| 80 | /** |
| 81 | * ethosu_mailbox_deinit() - Deinitialize mailbox |
| 82 | */ |
| 83 | void ethosu_mailbox_deinit(struct ethosu_mailbox *mbox); |
| 84 | |
| 85 | /** |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 86 | * ethosu_mailbox_register() - Register the ethosu_mailbox_msg in ethosu_mailbox |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 87 | * |
Mikael Olsson | 529cfad | 2023-06-14 17:14:14 +0200 | [diff] [blame] | 88 | * Context: Must be called with the device mutex locked |
| 89 | * |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 90 | * Return: 0 on success, else error code. |
| 91 | */ |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 92 | int ethosu_mailbox_register(struct ethosu_mailbox *mbox, |
| 93 | struct ethosu_mailbox_msg *msg); |
| 94 | |
| 95 | /** |
| 96 | * ethosu_mailbox_free_id() - Free the id of the ethosu_mailbox_msg |
Mikael Olsson | 529cfad | 2023-06-14 17:14:14 +0200 | [diff] [blame] | 97 | * |
| 98 | * Context: Must be called with the device mutex locked |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 99 | */ |
| 100 | void ethosu_mailbox_deregister(struct ethosu_mailbox *mbox, |
| 101 | struct ethosu_mailbox_msg *msg); |
| 102 | |
| 103 | /** |
| 104 | * ethosu_mailbox_find() - Find mailbox message |
| 105 | * |
Mikael Olsson | 529cfad | 2023-06-14 17:14:14 +0200 | [diff] [blame] | 106 | * Context: Must be called with the device mutex locked |
| 107 | * |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 108 | * Return: a valid pointer on success, otherwise an error ptr. |
| 109 | */ |
| 110 | struct ethosu_mailbox_msg *ethosu_mailbox_find(struct ethosu_mailbox *mbox, |
Mikael Olsson | 09965b0 | 2023-06-13 12:17:04 +0200 | [diff] [blame] | 111 | int msg_id, |
| 112 | uint32_t msg_type); |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 113 | |
| 114 | /** |
| 115 | * ethosu_mailbox_fail() - Fail mailbox messages |
| 116 | * |
| 117 | * Call fail() callback on all messages in pending list. |
Mikael Olsson | 529cfad | 2023-06-14 17:14:14 +0200 | [diff] [blame] | 118 | * |
| 119 | * Context: Must be called with the device mutex locked |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 120 | */ |
| 121 | void ethosu_mailbox_fail(struct ethosu_mailbox *mbox); |
| 122 | |
| 123 | /** |
Jonny Svärd | 7c24c77 | 2021-01-14 19:53:17 +0100 | [diff] [blame] | 124 | * ethosu_mailbox_reset() - Reset to end of queue |
| 125 | */ |
| 126 | void ethosu_mailbox_reset(struct ethosu_mailbox *mbox); |
| 127 | |
| 128 | /** |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 129 | * ethosu_mailbox_ping() - Send ping message |
| 130 | * |
| 131 | * Return: 0 on success, else error code. |
| 132 | */ |
| 133 | int ethosu_mailbox_ping(struct ethosu_mailbox *mbox); |
| 134 | |
| 135 | /** |
Jonny Svärd | 7c24c77 | 2021-01-14 19:53:17 +0100 | [diff] [blame] | 136 | * ethosu_mailbox_pong() - Send pong response |
| 137 | * |
| 138 | * Return: 0 on success, else error code. |
| 139 | */ |
| 140 | int ethosu_mailbox_pong(struct ethosu_mailbox *mbox); |
| 141 | |
| 142 | /** |
Mikael Olsson | 7c843dc | 2023-08-03 12:41:48 +0200 | [diff] [blame] | 143 | * ethosu_mailbox_version_request() - Send protocol version request |
Jonny Svärd | 7c24c77 | 2021-01-14 19:53:17 +0100 | [diff] [blame] | 144 | * |
| 145 | * Return: 0 on succes, else error code |
| 146 | */ |
Mikael Olsson | 7c843dc | 2023-08-03 12:41:48 +0200 | [diff] [blame] | 147 | int ethosu_mailbox_version_request(struct ethosu_mailbox *mbox, |
| 148 | struct ethosu_mailbox_msg *msg); |
Jonny Svärd | 7c24c77 | 2021-01-14 19:53:17 +0100 | [diff] [blame] | 149 | |
| 150 | /** |
Davide Grohmann | 35ce6c8 | 2021-06-01 15:03:51 +0200 | [diff] [blame] | 151 | * ethosu_mailbox_capabilities_request() - Send capabilities request |
| 152 | * |
| 153 | * Return: 0 on success, else error code. |
| 154 | */ |
| 155 | int ethosu_mailbox_capabilities_request(struct ethosu_mailbox *mbox, |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 156 | struct ethosu_mailbox_msg *msg); |
Davide Grohmann | 35ce6c8 | 2021-06-01 15:03:51 +0200 | [diff] [blame] | 157 | |
| 158 | /** |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 159 | * ethosu_mailbox_inference() - Send inference |
| 160 | * |
| 161 | * Return: 0 on success, else error code. |
| 162 | */ |
| 163 | int ethosu_mailbox_inference(struct ethosu_mailbox *mbox, |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 164 | struct ethosu_mailbox_msg *msg, |
Kristofer Jonsson | b74492c | 2020-09-10 13:26:01 +0200 | [diff] [blame] | 165 | uint32_t ifm_count, |
| 166 | struct ethosu_buffer **ifm, |
| 167 | uint32_t ofm_count, |
| 168 | struct ethosu_buffer **ofm, |
Per Åstrand | f7e407a | 2020-10-23 21:25:05 +0200 | [diff] [blame] | 169 | struct ethosu_buffer *network, |
Kristofer Jonsson | 35de9e6 | 2022-03-08 13:25:45 +0100 | [diff] [blame] | 170 | uint32_t network_index, |
Per Åstrand | f7e407a | 2020-10-23 21:25:05 +0200 | [diff] [blame] | 171 | uint8_t *pmu_event_config, |
| 172 | uint8_t pmu_event_config_count, |
| 173 | uint8_t pmu_cycle_counter_enable); |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 174 | |
Kristofer Jonsson | 3c6a260 | 2022-03-10 11:17:29 +0100 | [diff] [blame] | 175 | /** |
| 176 | * ethosu_mailbox_network_info_request() - Send network info request |
| 177 | * |
| 178 | * Return: 0 on success, else error code. |
| 179 | */ |
| 180 | int ethosu_mailbox_network_info_request(struct ethosu_mailbox *mbox, |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 181 | struct ethosu_mailbox_msg *msg, |
Kristofer Jonsson | 3c6a260 | 2022-03-10 11:17:29 +0100 | [diff] [blame] | 182 | struct ethosu_buffer *network, |
| 183 | uint32_t network_index); |
| 184 | |
Davide Grohmann | 7e8f508 | 2022-03-23 12:48:45 +0100 | [diff] [blame] | 185 | /** |
| 186 | * ethosu_mailbox_cancel_inference() - Send inference cancellation |
| 187 | * |
| 188 | * Return: 0 on success, else error code. |
| 189 | */ |
| 190 | int ethosu_mailbox_cancel_inference(struct ethosu_mailbox *mbox, |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 191 | struct ethosu_mailbox_msg *msg, |
| 192 | int inference_handle); |
Davide Grohmann | 7e8f508 | 2022-03-23 12:48:45 +0100 | [diff] [blame] | 193 | |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 194 | #endif /* ETHOSU_MAILBOX_H */ |