Andrew Jeffery | 4fe996c | 2018-02-27 12:16:48 +1030 | [diff] [blame] | 1 | // SPDX-License-Identifier: Apache-2.0 |
| 2 | // Copyright (C) 2018 IBM Corp. |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 3 | |
| 4 | #define _GNU_SOURCE |
| 5 | #include <assert.h> |
| 6 | #include <errno.h> |
| 7 | #include <fcntl.h> |
| 8 | #include <getopt.h> |
| 9 | #include <limits.h> |
| 10 | #include <poll.h> |
| 11 | #include <stdbool.h> |
| 12 | #include <stdint.h> |
| 13 | #include <stdio.h> |
| 14 | #include <stdlib.h> |
| 15 | #include <string.h> |
| 16 | #include <syslog.h> |
| 17 | #include <signal.h> |
| 18 | #include <sys/ioctl.h> |
| 19 | #include <sys/mman.h> |
| 20 | #include <sys/stat.h> |
| 21 | #include <sys/timerfd.h> |
| 22 | #include <sys/types.h> |
| 23 | #include <time.h> |
| 24 | #include <unistd.h> |
| 25 | #include <inttypes.h> |
| 26 | |
| 27 | #include "mbox.h" |
| 28 | #include "common.h" |
Andrew Jeffery | 457a6e5 | 2018-08-08 11:21:08 +0930 | [diff] [blame] | 29 | #include "transport_mbox.h" |
Andrew Jeffery | f593b1b | 2018-08-08 11:01:04 +0930 | [diff] [blame] | 30 | #include "windows.h" |
Andrew Jeffery | cd18611 | 2018-08-08 10:47:55 +0930 | [diff] [blame] | 31 | #include "lpc.h" |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 32 | |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 33 | struct errno_map { |
| 34 | int rc; |
| 35 | int mbox_errno; |
| 36 | }; |
| 37 | |
| 38 | static const struct errno_map errno_map_v1[] = { |
| 39 | { 0, MBOX_R_SUCCESS }, |
| 40 | { EACCES, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 41 | { EBADMSG, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 42 | { EBUSY, MBOX_R_SYSTEM_ERROR }, |
| 43 | { EINVAL, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 44 | { ENOTSUP, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 45 | { EPERM, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 46 | { EPROTO, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 47 | { ETIMEDOUT, MBOX_R_TIMEOUT }, |
| 48 | { -1, MBOX_R_SYSTEM_ERROR }, |
| 49 | }; |
| 50 | |
| 51 | static const struct errno_map errno_map_v2[] = { |
| 52 | { 0, MBOX_R_SUCCESS }, |
Andrew Jeffery | c7d1947 | 2018-08-08 11:43:08 +0930 | [diff] [blame] | 53 | { EACCES, MBOX_R_WINDOW_ERROR }, |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 54 | { EBADMSG, MBOX_R_SEQ_ERROR }, |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 55 | { EBUSY, MBOX_R_BUSY }, |
| 56 | { EINVAL, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 57 | { ENOTSUP, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 58 | { EPERM, MBOX_R_WINDOW_ERROR }, |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 59 | { EPROTO, MBOX_R_PARAM_ERROR }, |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 60 | { ETIMEDOUT, MBOX_R_TIMEOUT }, |
| 61 | { -1, MBOX_R_SYSTEM_ERROR }, |
| 62 | }; |
| 63 | |
| 64 | static const struct errno_map *errno_maps[] = { |
| 65 | [0] = NULL, |
| 66 | [1] = errno_map_v1, |
| 67 | [2] = errno_map_v2, |
| 68 | }; |
| 69 | |
| 70 | static inline int mbox_xlate_errno(struct mbox_context *context, |
| 71 | int rc) |
| 72 | { |
| 73 | const struct errno_map *entry; |
| 74 | |
| 75 | rc = -rc; |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 76 | MSG_DBG("Translating errno %d: %s\n", rc, strerror(rc)); |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 77 | for(entry = errno_maps[context->version]; entry->rc != -1; entry++) { |
| 78 | if (rc == entry->rc) { |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 79 | return entry->mbox_errno; |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 80 | } |
| 81 | } |
| 82 | |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 83 | return entry->mbox_errno; |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 84 | } |
| 85 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 86 | /* |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 87 | * transport_mbox_flush_events() - Write to the BMC controlled status register |
| 88 | * (reg 15) |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 89 | * @context: The mbox context pointer |
| 90 | * |
| 91 | * Return: 0 on success otherwise negative error code |
| 92 | */ |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 93 | static int transport_mbox_flush_events(struct mbox_context *context) |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 94 | { |
| 95 | int rc; |
| 96 | |
| 97 | /* Seek mbox registers */ |
| 98 | rc = lseek(context->fds[MBOX_FD].fd, MBOX_BMC_EVENT, SEEK_SET); |
| 99 | if (rc != MBOX_BMC_EVENT) { |
| 100 | MSG_ERR("Couldn't lseek mbox to byte %d: %s\n", MBOX_BMC_EVENT, |
| 101 | strerror(errno)); |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 102 | return -errno; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | /* Write to mbox status register */ |
| 106 | rc = write(context->fds[MBOX_FD].fd, &context->bmc_events, 1); |
| 107 | if (rc != 1) { |
| 108 | MSG_ERR("Couldn't write to BMC status reg: %s\n", |
| 109 | strerror(errno)); |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 110 | return -errno; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | /* Reset to start */ |
| 114 | rc = lseek(context->fds[MBOX_FD].fd, 0, SEEK_SET); |
| 115 | if (rc) { |
| 116 | MSG_ERR("Couldn't reset MBOX offset to zero: %s\n", |
| 117 | strerror(errno)); |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 118 | return -errno; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | return 0; |
| 122 | } |
| 123 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 124 | /* Command Handlers */ |
| 125 | |
| 126 | /* |
| 127 | * Command: RESET_STATE |
Deepak Kodihalli | 017e45c | 2017-07-12 01:06:30 -0500 | [diff] [blame] | 128 | * Reset the LPC mapping to point back at the flash, or memory in case we're |
| 129 | * using a virtual pnor. |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 130 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 131 | static int mbox_handle_reset(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 132 | union mbox_regs *req, struct mbox_msg *resp) |
| 133 | { |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 134 | return context->protocol->reset(context); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | /* |
| 138 | * Command: GET_MBOX_INFO |
| 139 | * Get the API version, default window size and block size |
| 140 | * We also set the LPC mapping to point to the reserved memory region here so |
| 141 | * this command must be called before any window manipulation |
| 142 | * |
| 143 | * V1: |
| 144 | * ARGS[0]: API Version |
| 145 | * |
| 146 | * RESP[0]: API Version |
| 147 | * RESP[1:2]: Default read window size (number of blocks) |
| 148 | * RESP[3:4]: Default write window size (number of blocks) |
| 149 | * RESP[5]: Block size (as shift) |
| 150 | * |
| 151 | * V2: |
| 152 | * ARGS[0]: API Version |
| 153 | * |
| 154 | * RESP[0]: API Version |
| 155 | * RESP[1:2]: Default read window size (number of blocks) |
| 156 | * RESP[3:4]: Default write window size (number of blocks) |
| 157 | * RESP[5]: Block size (as shift) |
| 158 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 159 | static int mbox_handle_mbox_info(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 160 | union mbox_regs *req, struct mbox_msg *resp) |
| 161 | { |
| 162 | uint8_t mbox_api_version = req->msg.args[0]; |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 163 | struct protocol_get_info io = { |
| 164 | .req = { .api_version = mbox_api_version } |
| 165 | }; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 166 | int rc; |
| 167 | |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 168 | rc = context->protocol->get_info(context, &io); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 169 | if (rc < 0) { |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 170 | return rc; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 171 | } |
| 172 | |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 173 | resp->args[0] = io.resp.api_version; |
| 174 | if (io.resp.api_version == API_VERSION_1) { |
| 175 | put_u16(&resp->args[1], io.resp.v1.read_window_size); |
| 176 | put_u16(&resp->args[3], io.resp.v1.write_window_size); |
| 177 | } else if (io.resp.api_version >= API_VERSION_2) { |
| 178 | resp->args[5] = io.resp.v2.block_size_shift; |
| 179 | put_u16(&resp->args[6], io.resp.v2.timeout); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | return 0; |
| 183 | } |
| 184 | |
| 185 | /* |
| 186 | * Command: GET_FLASH_INFO |
| 187 | * Get the flash size and erase granularity |
| 188 | * |
| 189 | * V1: |
| 190 | * RESP[0:3]: Flash Size (bytes) |
| 191 | * RESP[4:7]: Erase Size (bytes) |
| 192 | * V2: |
| 193 | * RESP[0:1]: Flash Size (number of blocks) |
| 194 | * RESP[2:3]: Erase Size (number of blocks) |
| 195 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 196 | static int mbox_handle_flash_info(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 197 | union mbox_regs *req, struct mbox_msg *resp) |
| 198 | { |
Andrew Jeffery | 91a8745 | 2018-08-07 14:54:14 +0930 | [diff] [blame] | 199 | struct protocol_get_flash_info io; |
| 200 | int rc; |
| 201 | |
| 202 | rc = context->protocol->get_flash_info(context, &io); |
| 203 | if (rc < 0) { |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 204 | return rc; |
Andrew Jeffery | 91a8745 | 2018-08-07 14:54:14 +0930 | [diff] [blame] | 205 | } |
| 206 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 207 | switch (context->version) { |
| 208 | case API_VERSION_1: |
| 209 | /* Both Sizes in Bytes */ |
Andrew Jeffery | 91a8745 | 2018-08-07 14:54:14 +0930 | [diff] [blame] | 210 | put_u32(&resp->args[0], io.resp.v1.flash_size); |
| 211 | put_u32(&resp->args[4], io.resp.v1.erase_size); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 212 | break; |
| 213 | case API_VERSION_2: |
| 214 | /* Both Sizes in Block Size */ |
Andrew Jeffery | 91a8745 | 2018-08-07 14:54:14 +0930 | [diff] [blame] | 215 | put_u16(&resp->args[0], io.resp.v2.flash_size); |
| 216 | put_u16(&resp->args[2], io.resp.v2.erase_size); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 217 | break; |
| 218 | default: |
| 219 | MSG_ERR("API Version Not Valid - Invalid System State\n"); |
| 220 | return -MBOX_R_SYSTEM_ERROR; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 221 | } |
| 222 | |
| 223 | return 0; |
| 224 | } |
| 225 | |
| 226 | /* |
| 227 | * get_lpc_addr_shifted() - Get lpc address of the current window |
| 228 | * @context: The mbox context pointer |
| 229 | * |
| 230 | * Return: The lpc address to access that offset shifted by block size |
| 231 | */ |
| 232 | static inline uint16_t get_lpc_addr_shifted(struct mbox_context *context) |
| 233 | { |
| 234 | uint32_t lpc_addr, mem_offset; |
| 235 | |
| 236 | /* Offset of the current window in the reserved memory region */ |
| 237 | mem_offset = context->current->mem - context->mem; |
| 238 | /* Total LPC Address */ |
| 239 | lpc_addr = context->lpc_base + mem_offset; |
| 240 | |
Suraj Jitindar Singh | 2851959 | 2017-04-27 14:48:58 +1000 | [diff] [blame] | 241 | MSG_DBG("LPC address of current window: 0x%.8x\n", lpc_addr); |
| 242 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 243 | return lpc_addr >> context->block_size_shift; |
| 244 | } |
| 245 | |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 246 | static int mbox_handle_create_window(struct mbox_context *context, bool ro, |
Andrew Jeffery | 4bcec8e | 2018-08-07 15:33:41 +0930 | [diff] [blame] | 247 | union mbox_regs *req, struct mbox_msg *resp) |
| 248 | { |
| 249 | struct protocol_create_window io; |
| 250 | int rc; |
| 251 | |
| 252 | io.req.offset = get_u16(&req->msg.args[0]); |
| 253 | io.req.ro = ro; |
| 254 | |
| 255 | rc = context->protocol->create_window(context, &io); |
| 256 | if (rc < 0) { |
| 257 | return rc; |
| 258 | } |
| 259 | |
| 260 | put_u16(&resp->args[0], io.resp.lpc_address); |
| 261 | if (context->version >= API_VERSION_2) { |
| 262 | put_u16(&resp->args[2], io.resp.size); |
| 263 | put_u16(&resp->args[4], io.resp.offset); |
| 264 | } |
| 265 | |
| 266 | return 0; |
| 267 | } |
| 268 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 269 | /* |
| 270 | * Command: CREATE_READ_WINDOW |
| 271 | * Opens a read window |
| 272 | * First checks if any current window with the requested data, if so we just |
| 273 | * point the host to that. Otherwise we read the request data in from flash and |
| 274 | * point the host there. |
| 275 | * |
| 276 | * V1: |
| 277 | * ARGS[0:1]: Window Location as Offset into Flash (number of blocks) |
| 278 | * |
| 279 | * RESP[0:1]: LPC bus address for host to access this window (number of blocks) |
| 280 | * |
| 281 | * V2: |
| 282 | * ARGS[0:1]: Window Location as Offset into Flash (number of blocks) |
| 283 | * ARGS[2:3]: Requested window size (number of blocks) |
| 284 | * |
| 285 | * RESP[0:1]: LPC bus address for host to access this window (number of blocks) |
| 286 | * RESP[2:3]: Actual window size that the host can access (number of blocks) |
| 287 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 288 | static int mbox_handle_read_window(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 289 | union mbox_regs *req, struct mbox_msg *resp) |
| 290 | { |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 291 | return mbox_handle_create_window(context, true, req, resp); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 292 | } |
| 293 | |
| 294 | /* |
| 295 | * Command: CREATE_WRITE_WINDOW |
| 296 | * Opens a write window |
| 297 | * First checks if any current window with the requested data, if so we just |
| 298 | * point the host to that. Otherwise we read the request data in from flash and |
| 299 | * point the host there. |
| 300 | * |
| 301 | * V1: |
| 302 | * ARGS[0:1]: Window Location as Offset into Flash (number of blocks) |
| 303 | * |
| 304 | * RESP[0:1]: LPC bus address for host to access this window (number of blocks) |
| 305 | * |
| 306 | * V2: |
| 307 | * ARGS[0:1]: Window Location as Offset into Flash (number of blocks) |
| 308 | * ARGS[2:3]: Requested window size (number of blocks) |
| 309 | * |
| 310 | * RESP[0:1]: LPC bus address for host to access this window (number of blocks) |
| 311 | * RESP[2:3]: Actual window size that was mapped/host can access (n.o. blocks) |
| 312 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 313 | static int mbox_handle_write_window(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 314 | union mbox_regs *req, struct mbox_msg *resp) |
| 315 | { |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 316 | return mbox_handle_create_window(context, false, req, resp); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 317 | } |
| 318 | |
| 319 | /* |
| 320 | * Commands: MARK_WRITE_DIRTY |
| 321 | * Marks a portion of the current (write) window dirty, informing the daemon |
| 322 | * that is has been written to and thus must be at some point written to the |
| 323 | * backing store |
| 324 | * These changes aren't written back to the backing store unless flush is then |
| 325 | * called or the window closed |
| 326 | * |
| 327 | * V1: |
| 328 | * ARGS[0:1]: Where within flash to start (number of blocks) |
| 329 | * ARGS[2:5]: Number to mark dirty (number of bytes) |
| 330 | * |
| 331 | * V2: |
| 332 | * ARGS[0:1]: Where within window to start (number of blocks) |
| 333 | * ARGS[2:3]: Number to mark dirty (number of blocks) |
| 334 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 335 | static int mbox_handle_dirty_window(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 336 | union mbox_regs *req, struct mbox_msg *resp) |
| 337 | { |
Andrew Jeffery | a336e43 | 2018-08-07 16:00:40 +0930 | [diff] [blame] | 338 | struct protocol_mark_dirty io; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 339 | |
Andrew Jeffery | a336e43 | 2018-08-07 16:00:40 +0930 | [diff] [blame] | 340 | if (context->version == API_VERSION_1) { |
| 341 | io.req.v1.offset = get_u16(&req->msg.args[0]); |
| 342 | io.req.v1.size = get_u32(&req->msg.args[2]); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 343 | } else { |
Andrew Jeffery | a336e43 | 2018-08-07 16:00:40 +0930 | [diff] [blame] | 344 | io.req.v2.offset = get_u16(&req->msg.args[0]); |
| 345 | io.req.v2.size = get_u16(&req->msg.args[2]); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 346 | } |
| 347 | |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 348 | return context->protocol->mark_dirty(context, &io); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 349 | } |
| 350 | |
| 351 | /* |
| 352 | * Commands: MARK_WRITE_ERASE |
| 353 | * Erases a portion of the current window |
| 354 | * These changes aren't written back to the backing store unless flush is then |
| 355 | * called or the window closed |
| 356 | * |
| 357 | * V1: |
| 358 | * Unimplemented |
| 359 | * |
| 360 | * V2: |
| 361 | * ARGS[0:1]: Where within window to start (number of blocks) |
| 362 | * ARGS[2:3]: Number to erase (number of blocks) |
| 363 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 364 | static int mbox_handle_erase_window(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 365 | union mbox_regs *req, struct mbox_msg *resp) |
| 366 | { |
Andrew Jeffery | 62a3daa | 2018-08-07 22:30:32 +0930 | [diff] [blame] | 367 | struct protocol_erase io; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 368 | |
Andrew Jeffery | 62a3daa | 2018-08-07 22:30:32 +0930 | [diff] [blame] | 369 | io.req.offset = get_u16(&req->msg.args[0]); |
| 370 | io.req.size = get_u16(&req->msg.args[2]); |
| 371 | |
| 372 | if (!context->protocol->erase) { |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 373 | MSG_ERR("Protocol Version invalid for Erase Command\n"); |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 374 | return -ENOTSUP; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 375 | } |
| 376 | |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 377 | return context->protocol->erase(context, &io); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 378 | } |
| 379 | |
| 380 | /* |
| 381 | * Command: WRITE_FLUSH |
| 382 | * Flushes any dirty or erased blocks in the current window back to the backing |
| 383 | * store |
| 384 | * NOTE: For V1 this behaves much the same as the dirty command in that it |
| 385 | * takes an offset and number of blocks to dirty, then also performs a flush as |
| 386 | * part of the same command. For V2 this will only flush blocks already marked |
| 387 | * dirty/erased with the appropriate commands and doesn't take any arguments |
| 388 | * directly. |
| 389 | * |
| 390 | * V1: |
| 391 | * ARGS[0:1]: Where within window to start (number of blocks) |
| 392 | * ARGS[2:5]: Number to mark dirty (number of bytes) |
| 393 | * |
| 394 | * V2: |
| 395 | * NONE |
| 396 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 397 | static int mbox_handle_flush_window(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 398 | union mbox_regs *req, struct mbox_msg *resp) |
| 399 | { |
Andrew Jeffery | 9b920cf | 2018-08-07 22:49:19 +0930 | [diff] [blame] | 400 | struct protocol_flush io = { 0 }; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 401 | |
Andrew Jeffery | 9b920cf | 2018-08-07 22:49:19 +0930 | [diff] [blame] | 402 | if (context->version == API_VERSION_1) { |
| 403 | io.req.offset = get_u16(&req->msg.args[0]); |
| 404 | io.req.size = get_u32(&req->msg.args[2]); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 405 | } |
| 406 | |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 407 | return context->protocol->flush(context, &io); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 408 | } |
| 409 | |
| 410 | /* |
| 411 | * Command: CLOSE_WINDOW |
| 412 | * Close the current window |
| 413 | * NOTE: There is an implicit flush |
| 414 | * |
| 415 | * V1: |
| 416 | * NONE |
| 417 | * |
| 418 | * V2: |
| 419 | * ARGS[0]: FLAGS |
| 420 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 421 | static int mbox_handle_close_window(struct mbox_context *context, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 422 | union mbox_regs *req, struct mbox_msg *resp) |
| 423 | { |
Andrew Jeffery | 093eda5 | 2018-08-07 23:10:43 +0930 | [diff] [blame] | 424 | struct protocol_close io = { 0 }; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 425 | |
Andrew Jeffery | 093eda5 | 2018-08-07 23:10:43 +0930 | [diff] [blame] | 426 | if (context->version >= API_VERSION_2) { |
| 427 | io.req.flags = req->msg.args[0]; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 428 | } |
| 429 | |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 430 | return context->protocol->close(context, &io); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 431 | } |
| 432 | |
| 433 | /* |
| 434 | * Command: BMC_EVENT_ACK |
| 435 | * Sent by the host to acknowledge BMC events supplied in mailbox register 15 |
| 436 | * |
| 437 | * ARGS[0]: Bitmap of bits to ack (by clearing) |
| 438 | */ |
Andrew Jeffery | f21c81c | 2018-08-09 13:57:46 +0930 | [diff] [blame] | 439 | static int mbox_handle_ack(struct mbox_context *context, union mbox_regs *req, |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 440 | struct mbox_msg *resp) |
| 441 | { |
Andrew Jeffery | c5c8304 | 2018-08-07 23:22:05 +0930 | [diff] [blame] | 442 | struct protocol_ack io; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 443 | |
Andrew Jeffery | c5c8304 | 2018-08-07 23:22:05 +0930 | [diff] [blame] | 444 | io.req.flags = req->msg.args[0]; |
| 445 | |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 446 | return context->protocol->ack(context, &io); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 447 | } |
| 448 | |
| 449 | /* |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 450 | * check_req_valid() - Check if the given request is a valid mbox request |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 451 | * @context: The mbox context pointer |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 452 | * @cmd: The request registers |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 453 | * |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 454 | * Return: 0 if request is valid otherwise negative error code |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 455 | */ |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 456 | static int check_req_valid(struct mbox_context *context, union mbox_regs *req) |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 457 | { |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 458 | uint8_t cmd = req->msg.command; |
| 459 | uint8_t seq = req->msg.seq; |
| 460 | |
| 461 | if (cmd > NUM_MBOX_CMDS) { |
Andrew Jeffery | 121dc0d | 2017-04-24 16:15:06 +0930 | [diff] [blame] | 462 | MSG_ERR("Unknown mbox command: %d\n", cmd); |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 463 | return -ENOTSUP; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 464 | } |
Andrew Jeffery | 121dc0d | 2017-04-24 16:15:06 +0930 | [diff] [blame] | 465 | |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 466 | if (seq == context->prev_seq && cmd != MBOX_C_GET_MBOX_INFO) { |
Suraj Jitindar Singh | 2851959 | 2017-04-27 14:48:58 +1000 | [diff] [blame] | 467 | MSG_ERR("Invalid sequence number: %d, previous: %d\n", seq, |
| 468 | context->prev_seq); |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 469 | return -EBADMSG; |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 470 | } |
| 471 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 472 | if (context->state & STATE_SUSPENDED) { |
| 473 | if (cmd != MBOX_C_GET_MBOX_INFO && cmd != MBOX_C_ACK) { |
| 474 | MSG_ERR("Cannot use that cmd while suspended: %d\n", |
| 475 | cmd); |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 476 | return -EBUSY; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 477 | } |
| 478 | } |
Andrew Jeffery | 121dc0d | 2017-04-24 16:15:06 +0930 | [diff] [blame] | 479 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 480 | if (!(context->state & MAPS_MEM)) { |
| 481 | if (cmd != MBOX_C_RESET_STATE && cmd != MBOX_C_GET_MBOX_INFO |
| 482 | && cmd != MBOX_C_ACK) { |
Andrew Jeffery | 121dc0d | 2017-04-24 16:15:06 +0930 | [diff] [blame] | 483 | MSG_ERR("Must call GET_MBOX_INFO before %d\n", cmd); |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 484 | return -EPROTO; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 485 | } |
| 486 | } |
| 487 | |
| 488 | return 0; |
| 489 | } |
| 490 | |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 491 | typedef int (*mboxd_mbox_handler)(struct mbox_context *, union mbox_regs *, |
| 492 | struct mbox_msg *); |
| 493 | |
| 494 | static const mboxd_mbox_handler transport_mbox_handlers[] = { |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 495 | mbox_handle_reset, |
| 496 | mbox_handle_mbox_info, |
| 497 | mbox_handle_flash_info, |
| 498 | mbox_handle_read_window, |
| 499 | mbox_handle_close_window, |
| 500 | mbox_handle_write_window, |
| 501 | mbox_handle_dirty_window, |
| 502 | mbox_handle_flush_window, |
| 503 | mbox_handle_ack, |
| 504 | mbox_handle_erase_window |
| 505 | }; |
| 506 | |
| 507 | /* |
| 508 | * handle_mbox_req() - Handle an incoming mbox command request |
| 509 | * @context: The mbox context pointer |
| 510 | * @req: The mbox request message |
| 511 | * |
| 512 | * Return: 0 if handled successfully otherwise negative error code |
| 513 | */ |
| 514 | static int handle_mbox_req(struct mbox_context *context, union mbox_regs *req) |
| 515 | { |
| 516 | struct mbox_msg resp = { |
| 517 | .command = req->msg.command, |
| 518 | .seq = req->msg.seq, |
| 519 | .args = { 0 }, |
| 520 | .response = MBOX_R_SUCCESS |
| 521 | }; |
Suraj Jitindar Singh | 2851959 | 2017-04-27 14:48:58 +1000 | [diff] [blame] | 522 | int rc = 0, len, i; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 523 | |
Suraj Jitindar Singh | 2851959 | 2017-04-27 14:48:58 +1000 | [diff] [blame] | 524 | MSG_INFO("Received MBOX command: %u\n", req->msg.command); |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 525 | rc = check_req_valid(context, req); |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 526 | if (!rc) { |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 527 | mboxd_mbox_handler handler; |
| 528 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 529 | /* Commands start at 1 so we have to subtract 1 from the cmd */ |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 530 | handler = transport_mbox_handlers[req->msg.command - 1]; |
| 531 | rc = handler(context, req, &resp); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 532 | if (rc < 0) { |
| 533 | MSG_ERR("Error handling mbox cmd: %d\n", |
| 534 | req->msg.command); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 535 | } |
| 536 | } |
| 537 | |
Andrew Jeffery | 2f1477c | 2018-08-09 23:24:38 +0930 | [diff] [blame] | 538 | rc = mbox_xlate_errno(context, rc); |
| 539 | resp.response = rc; |
Andrew Jeffery | 55dede6 | 2017-04-24 16:13:06 +0930 | [diff] [blame] | 540 | context->prev_seq = req->msg.seq; |
| 541 | |
Suraj Jitindar Singh | 2851959 | 2017-04-27 14:48:58 +1000 | [diff] [blame] | 542 | MSG_DBG("Writing MBOX response:\n"); |
| 543 | MSG_DBG("MBOX cmd: %u\n", resp.command); |
| 544 | MSG_DBG("MBOX seq: %u\n", resp.seq); |
| 545 | for (i = 0; i < MBOX_ARGS_BYTES; i++) { |
| 546 | MSG_DBG("MBOX arg[%d]: 0x%.2x\n", i, resp.args[i]); |
| 547 | } |
| 548 | MSG_INFO("Writing MBOX response: %u\n", resp.response); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 549 | len = write(context->fds[MBOX_FD].fd, &resp, sizeof(resp)); |
| 550 | if (len < sizeof(resp)) { |
| 551 | MSG_ERR("Didn't write the full response\n"); |
| 552 | rc = -errno; |
| 553 | } |
| 554 | |
| 555 | return rc; |
| 556 | } |
| 557 | |
| 558 | /* |
| 559 | * get_message() - Read an mbox request message from the mbox registers |
| 560 | * @context: The mbox context pointer |
| 561 | * @msg: Where to put the received message |
| 562 | * |
| 563 | * Return: 0 if read successfully otherwise negative error code |
| 564 | */ |
| 565 | static int get_message(struct mbox_context *context, union mbox_regs *msg) |
| 566 | { |
Suraj Jitindar Singh | 2851959 | 2017-04-27 14:48:58 +1000 | [diff] [blame] | 567 | int rc, i; |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 568 | |
| 569 | rc = read(context->fds[MBOX_FD].fd, msg, sizeof(msg->raw)); |
| 570 | if (rc < 0) { |
| 571 | MSG_ERR("Couldn't read: %s\n", strerror(errno)); |
| 572 | return -errno; |
| 573 | } else if (rc < sizeof(msg->raw)) { |
| 574 | MSG_ERR("Short read: %d expecting %zu\n", rc, sizeof(msg->raw)); |
| 575 | return -1; |
| 576 | } |
| 577 | |
Suraj Jitindar Singh | 2851959 | 2017-04-27 14:48:58 +1000 | [diff] [blame] | 578 | MSG_DBG("Received MBOX request:\n"); |
| 579 | MSG_DBG("MBOX cmd: %u\n", msg->msg.command); |
| 580 | MSG_DBG("MBOX seq: %u\n", msg->msg.seq); |
| 581 | for (i = 0; i < MBOX_ARGS_BYTES; i++) { |
| 582 | MSG_DBG("MBOX arg[%d]: 0x%.2x\n", i, msg->msg.args[i]); |
| 583 | } |
| 584 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 585 | return 0; |
| 586 | } |
| 587 | |
| 588 | /* |
Andrew Jeffery | d86141b | 2018-08-09 14:58:53 +0930 | [diff] [blame] | 589 | * transport_mbox_dispatch() - handle an mbox interrupt |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 590 | * @context: The mbox context pointer |
| 591 | * |
| 592 | * Return: 0 if handled successfully otherwise negative error code |
| 593 | */ |
Andrew Jeffery | d86141b | 2018-08-09 14:58:53 +0930 | [diff] [blame] | 594 | int transport_mbox_dispatch(struct mbox_context *context) |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 595 | { |
| 596 | int rc = 0; |
| 597 | union mbox_regs req = { 0 }; |
| 598 | |
| 599 | assert(context); |
| 600 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 601 | rc = get_message(context, &req); |
| 602 | if (rc) { |
| 603 | return rc; |
| 604 | } |
| 605 | |
| 606 | return handle_mbox_req(context, &req); |
| 607 | } |
| 608 | |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 609 | static const struct transport_ops transport_mbox_ops = { |
| 610 | .flush_events = transport_mbox_flush_events, |
| 611 | }; |
| 612 | |
Andrew Jeffery | b2466ee | 2018-08-09 15:03:27 +0930 | [diff] [blame] | 613 | int __transport_mbox_init(struct mbox_context *context, const char *path) |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 614 | { |
| 615 | int fd; |
| 616 | |
Andrew Jeffery | 5335f09 | 2018-08-09 14:56:08 +0930 | [diff] [blame] | 617 | context->transport = &transport_mbox_ops; |
Andrew Jeffery | efb09de | 2018-03-26 14:36:43 +1030 | [diff] [blame] | 618 | |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 619 | /* Open MBOX Device */ |
Andrew Jeffery | 913740f | 2017-04-10 23:51:07 +0930 | [diff] [blame] | 620 | fd = open(path, O_RDWR | O_NONBLOCK); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 621 | if (fd < 0) { |
| 622 | MSG_ERR("Couldn't open %s with flags O_RDWR: %s\n", |
Andrew Jeffery | 913740f | 2017-04-10 23:51:07 +0930 | [diff] [blame] | 623 | path, strerror(errno)); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 624 | return -errno; |
| 625 | } |
Suraj Jitindar Singh | 2851959 | 2017-04-27 14:48:58 +1000 | [diff] [blame] | 626 | MSG_DBG("Opened mbox dev: %s\n", path); |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 627 | |
| 628 | context->fds[MBOX_FD].fd = fd; |
| 629 | |
| 630 | return 0; |
| 631 | } |
| 632 | |
Andrew Jeffery | b2466ee | 2018-08-09 15:03:27 +0930 | [diff] [blame] | 633 | int transport_mbox_init(struct mbox_context *context) |
Andrew Jeffery | 913740f | 2017-04-10 23:51:07 +0930 | [diff] [blame] | 634 | { |
Andrew Jeffery | b2466ee | 2018-08-09 15:03:27 +0930 | [diff] [blame] | 635 | return __transport_mbox_init(context, MBOX_HOST_PATH); |
Andrew Jeffery | 913740f | 2017-04-10 23:51:07 +0930 | [diff] [blame] | 636 | } |
| 637 | |
Andrew Jeffery | 55260ce | 2018-08-09 15:05:59 +0930 | [diff] [blame^] | 638 | void transport_mbox_free(struct mbox_context *context) |
Suraj Jitindar Singh | e39c916 | 2017-03-28 10:47:43 +1100 | [diff] [blame] | 639 | { |
| 640 | close(context->fds[MBOX_FD].fd); |
| 641 | } |