Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 1 | /* |
Mikael Olsson | d4ad9e5 | 2024-02-07 11:22:26 +0100 | [diff] [blame] | 2 | * SPDX-FileCopyrightText: Copyright 2020-2024 Arm Limited and/or its affiliates <open-source-office@arm.com> |
| 3 | * SPDX-License-Identifier: GPL-2.0-only |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 4 | * |
| 5 | * This program is free software and is provided to you under the terms of the |
| 6 | * GNU General Public License version 2 as published by the Free Software |
| 7 | * Foundation, and any use by you of this program is subject to the terms |
| 8 | * of such GNU licence. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program; if not, you can access it online at |
| 17 | * http://www.gnu.org/licenses/gpl-2.0.html. |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 18 | */ |
| 19 | |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 20 | #ifndef ETHOSU_RPMSG_H |
| 21 | #define ETHOSU_RPMSG_H |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 22 | |
| 23 | #ifdef __KERNEL__ |
| 24 | #include <linux/types.h> |
| 25 | #else |
| 26 | #include <stdint.h> |
| 27 | #endif |
| 28 | |
| 29 | #ifdef __cplusplus |
| 30 | namespace EthosU { |
| 31 | #endif |
| 32 | |
| 33 | /** Maximum number of IFM/OFM buffers per inference */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 34 | #define ETHOSU_RPMSG_BUFFER_MAX 16 |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 35 | |
| 36 | /** Maximum number of PMU counters to be returned for inference */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 37 | #define ETHOSU_RPMSG_PMU_MAX 8 |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 38 | |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 39 | #define ETHOSU_RPMSG_MAGIC 0x41457631 |
| 40 | #define ETHOSU_RPMSG_VERSION_MAJOR 0 |
| 41 | #define ETHOSU_RPMSG_VERSION_MINOR 2 |
| 42 | #define ETHOSU_RPMSG_VERSION_PATCH 0 |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 43 | |
| 44 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 45 | * enum ethosu_rpmsg_type - Message types |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 46 | * |
| 47 | * Types for the messages sent between the host and the core subsystem. |
| 48 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 49 | enum ethosu_rpmsg_type { |
| 50 | ETHOSU_RPMSG_ERR = 1, |
| 51 | ETHOSU_RPMSG_PING, |
| 52 | ETHOSU_RPMSG_PONG, |
| 53 | ETHOSU_RPMSG_INFERENCE_REQ, |
| 54 | ETHOSU_RPMSG_INFERENCE_RSP, |
| 55 | ETHOSU_RPMSG_VERSION_REQ, |
| 56 | ETHOSU_RPMSG_VERSION_RSP, |
| 57 | ETHOSU_RPMSG_CAPABILITIES_REQ, |
| 58 | ETHOSU_RPMSG_CAPABILITIES_RSP, |
| 59 | ETHOSU_RPMSG_NETWORK_INFO_REQ, |
| 60 | ETHOSU_RPMSG_NETWORK_INFO_RSP, |
| 61 | ETHOSU_RPMSG_CANCEL_INFERENCE_REQ, |
| 62 | ETHOSU_RPMSG_CANCEL_INFERENCE_RSP, |
| 63 | ETHOSU_RPMSG_MAX |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 64 | }; |
| 65 | |
| 66 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 67 | * struct ethosu_rpmsg_header - Message header |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 68 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 69 | struct ethosu_rpmsg_header { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 70 | uint32_t magic; |
| 71 | uint32_t type; |
| 72 | uint64_t msg_id; |
| 73 | }; |
| 74 | |
| 75 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 76 | * enum ethosu_rpmsg_status - Status |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 77 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 78 | enum ethosu_rpmsg_status { |
| 79 | ETHOSU_RPMSG_STATUS_OK, |
| 80 | ETHOSU_RPMSG_STATUS_ERROR, |
| 81 | ETHOSU_RPMSG_STATUS_RUNNING, |
| 82 | ETHOSU_RPMSG_STATUS_REJECTED, |
| 83 | ETHOSU_RPMSG_STATUS_ABORTED, |
| 84 | ETHOSU_RPMSG_STATUS_ABORTING, |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 85 | }; |
| 86 | |
| 87 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 88 | * struct ethosu_rpmsg_buffer - Buffer descriptor |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 89 | * |
| 90 | * Pointer and size to a buffer within the Ethos-U address space. |
| 91 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 92 | struct ethosu_rpmsg_buffer { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 93 | uint32_t ptr; |
| 94 | uint32_t size; |
| 95 | }; |
| 96 | |
| 97 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 98 | * enum ethosu_rpmsg_network_type - Network buffer type |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 99 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 100 | enum ethosu_rpmsg_network_type { |
| 101 | ETHOSU_RPMSG_NETWORK_BUFFER = 1, |
| 102 | ETHOSU_RPMSG_NETWORK_INDEX |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 103 | }; |
| 104 | |
| 105 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 106 | * struct ethosu_rpmsg_network_buffer - Network buffer |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 107 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 108 | struct ethosu_rpmsg_network_buffer { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 109 | uint32_t type; |
| 110 | union { |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 111 | struct ethosu_rpmsg_buffer buffer; |
| 112 | uint32_t index; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 113 | }; |
| 114 | }; |
| 115 | |
| 116 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 117 | * struct ethosu_rpmsg_inference_req - Inference request |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 118 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 119 | struct ethosu_rpmsg_inference_req { |
| 120 | uint32_t ifm_count; |
| 121 | struct ethosu_rpmsg_buffer ifm[ETHOSU_RPMSG_BUFFER_MAX]; |
| 122 | uint32_t ofm_count; |
| 123 | struct ethosu_rpmsg_buffer ofm[ETHOSU_RPMSG_BUFFER_MAX]; |
| 124 | struct ethosu_rpmsg_network_buffer network; |
| 125 | uint8_t pmu_event_config[ETHOSU_RPMSG_PMU_MAX |
| 126 | ]; |
| 127 | uint32_t pmu_cycle_counter_enable; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 128 | }; |
| 129 | |
| 130 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 131 | * struct ethosu_rpmsg_inference_rsp - Inference response |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 132 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 133 | struct ethosu_rpmsg_inference_rsp { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 134 | uint32_t ofm_count; |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 135 | uint32_t ofm_size[ETHOSU_RPMSG_BUFFER_MAX]; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 136 | uint32_t status; |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 137 | uint8_t pmu_event_config[ETHOSU_RPMSG_PMU_MAX]; |
| 138 | uint64_t pmu_event_count[ETHOSU_RPMSG_PMU_MAX]; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 139 | uint32_t pmu_cycle_counter_enable; |
| 140 | uint64_t pmu_cycle_counter_count; |
| 141 | }; |
| 142 | |
| 143 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 144 | * struct ethosu_rpmsg_network_info_req - Network information request |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 145 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 146 | struct ethosu_rpmsg_network_info_req { |
| 147 | struct ethosu_rpmsg_network_buffer network; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 148 | }; |
| 149 | |
| 150 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 151 | * struct ethosu_rpmsg_network_info_rsp - Network information response |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 152 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 153 | struct ethosu_rpmsg_network_info_rsp { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 154 | char desc[32]; |
| 155 | uint32_t ifm_count; |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 156 | uint32_t ifm_size[ETHOSU_RPMSG_BUFFER_MAX]; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 157 | uint32_t ofm_count; |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 158 | uint32_t ofm_size[ETHOSU_RPMSG_BUFFER_MAX]; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 159 | uint32_t status; |
| 160 | }; |
| 161 | |
| 162 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 163 | * struct ethosu_rpmsg_version_rsp - Message protocol version |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 164 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 165 | struct ethosu_rpmsg_version_rsp { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 166 | uint8_t major; |
| 167 | uint8_t minor; |
| 168 | uint8_t patch; |
| 169 | uint8_t _reserved; |
| 170 | }; |
| 171 | |
| 172 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 173 | * struct ethosu_rpmsg_capabilities_rsp - Message capabilities response |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 174 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 175 | struct ethosu_rpmsg_capabilities_rsp { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 176 | uint32_t version_status; |
| 177 | uint32_t version_minor; |
| 178 | uint32_t version_major; |
| 179 | uint32_t product_major; |
| 180 | uint32_t arch_patch_rev; |
| 181 | uint32_t arch_minor_rev; |
| 182 | uint32_t arch_major_rev; |
| 183 | uint32_t driver_patch_rev; |
| 184 | uint32_t driver_minor_rev; |
| 185 | uint32_t driver_major_rev; |
| 186 | uint32_t macs_per_cc; |
| 187 | uint32_t cmd_stream_version; |
| 188 | uint32_t custom_dma; |
| 189 | }; |
| 190 | |
| 191 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 192 | * struct ethosu_rpmsg_cancel_inference_req - Message cancel inference |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 193 | * request |
| 194 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 195 | struct ethosu_rpmsg_cancel_inference_req { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 196 | uint64_t inference_handle; |
| 197 | }; |
| 198 | |
| 199 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 200 | * struct ethosu_rpmsg_cancel_inference_rsp - Message cancel inference |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 201 | * response |
| 202 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 203 | struct ethosu_rpmsg_cancel_inference_rsp { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 204 | uint32_t status; |
| 205 | }; |
| 206 | |
| 207 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 208 | * enum ethosu_rpmsg_err_type - Error types |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 209 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 210 | enum ethosu_rpmsg_err_type { |
| 211 | ETHOSU_RPMSG_ERR_GENERIC = 0, |
| 212 | ETHOSU_RPMSG_ERR_UNSUPPORTED_TYPE, |
| 213 | ETHOSU_RPMSG_ERR_INVALID_PAYLOAD, |
| 214 | ETHOSU_RPMSG_ERR_INVALID_SIZE, |
| 215 | ETHOSU_RPMSG_ERR_INVALID_MAGIC, |
| 216 | ETHOSU_RPMSG_ERR_MAX |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 217 | }; |
| 218 | |
| 219 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 220 | * struct ethosu_rpmsg_err - Error message struct |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 221 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 222 | struct ethosu_rpmsg_err { |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 223 | uint32_t type; /* optional use of extra error code */ |
| 224 | char msg[128]; |
| 225 | }; |
| 226 | |
| 227 | /** |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 228 | * struct ethosu_rpmsg - Rpmsg message |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 229 | */ |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 230 | struct ethosu_rpmsg { |
| 231 | struct ethosu_rpmsg_header header; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 232 | union { |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 233 | struct ethosu_rpmsg_inference_req inf_req; |
| 234 | struct ethosu_rpmsg_inference_rsp inf_rsp; |
| 235 | struct ethosu_rpmsg_network_info_req net_info_req; |
| 236 | struct ethosu_rpmsg_network_info_rsp net_info_rsp; |
| 237 | struct ethosu_rpmsg_capabilities_rsp cap_rsp; |
| 238 | struct ethosu_rpmsg_cancel_inference_req cancel_req; |
| 239 | struct ethosu_rpmsg_cancel_inference_rsp cancel_rsp; |
| 240 | struct ethosu_rpmsg_version_rsp version_rsp; |
| 241 | struct ethosu_rpmsg_err error; |
Kristofer Jonsson | 964c0ac | 2023-01-11 15:59:34 +0100 | [diff] [blame] | 242 | }; |
| 243 | }; |
| 244 | |
| 245 | #ifdef __cplusplus |
| 246 | } /*namespace EthosU */ |
| 247 | #endif |
| 248 | |
Mikael Olsson | 16be285 | 2024-02-12 09:56:56 +0100 | [diff] [blame] | 249 | #endif /* ETHOSU_RPMSG_H */ |