Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 1 | /* SPDX-License-Identifier: Apache-2.0 */ |
| 2 | /* Copyright (C) 2018 IBM Corp. */ |
| 3 | |
| 4 | #ifndef PROTOCOL_H |
| 5 | #define PROTOCOL_H |
| 6 | |
| 7 | struct mbox_context; |
| 8 | |
| 9 | /* |
| 10 | * The GET_MBOX_INFO command is special as it can change the interface based on |
| 11 | * negotiation. As such we need to accommodate all response types |
| 12 | */ |
| 13 | struct protocol_get_info { |
| 14 | struct { |
| 15 | uint8_t api_version; |
| 16 | } req; |
| 17 | struct { |
| 18 | uint8_t api_version; |
| 19 | union { |
| 20 | struct { |
| 21 | uint16_t read_window_size; |
| 22 | uint16_t write_window_size; |
| 23 | } v1; |
| 24 | struct { |
| 25 | uint8_t block_size_shift; |
| 26 | uint16_t timeout; |
| 27 | } v2; |
| 28 | }; |
| 29 | } resp; |
| 30 | }; |
| 31 | |
Andrew Jeffery | 91a8745 | 2018-08-07 14:54:14 +0930 | [diff] [blame] | 32 | struct protocol_get_flash_info { |
| 33 | struct { |
| 34 | union { |
| 35 | struct { |
| 36 | uint32_t flash_size; |
| 37 | uint32_t erase_size; |
| 38 | } v1; |
| 39 | struct { |
| 40 | uint16_t flash_size; |
| 41 | uint16_t erase_size; |
| 42 | } v2; |
| 43 | }; |
| 44 | } resp; |
| 45 | }; |
| 46 | |
Andrew Jeffery | 22fa500 | 2018-08-07 15:22:50 +0930 | [diff] [blame^] | 47 | struct protocol_create_window { |
| 48 | struct { |
| 49 | uint16_t offset; |
| 50 | uint16_t size; |
| 51 | uint8_t id; |
| 52 | } req; |
| 53 | struct { |
| 54 | uint16_t lpc_address; |
| 55 | uint16_t size; |
| 56 | uint16_t offset; |
| 57 | } resp; |
| 58 | }; |
| 59 | |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 60 | struct protocol_ops { |
Andrew Jeffery | ab666a5 | 2018-08-07 14:28:09 +0930 | [diff] [blame] | 61 | int (*reset)(struct mbox_context *context); |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 62 | int (*get_info)(struct mbox_context *context, |
| 63 | struct protocol_get_info *io); |
Andrew Jeffery | 91a8745 | 2018-08-07 14:54:14 +0930 | [diff] [blame] | 64 | int (*get_flash_info)(struct mbox_context *context, |
| 65 | struct protocol_get_flash_info *io); |
Andrew Jeffery | 22fa500 | 2018-08-07 15:22:50 +0930 | [diff] [blame^] | 66 | int (*create_read_window)(struct mbox_context *context, |
| 67 | struct protocol_create_window *io); |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 68 | }; |
| 69 | |
| 70 | int protocol_init(struct mbox_context *context); |
| 71 | void protocol_free(struct mbox_context *context); |
| 72 | |
| 73 | int protocol_negotiate_version(struct mbox_context *context, uint8_t requested); |
| 74 | |
| 75 | /* Protocol v1 */ |
Andrew Jeffery | ab666a5 | 2018-08-07 14:28:09 +0930 | [diff] [blame] | 76 | int protocol_v1_reset(struct mbox_context *context); |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 77 | int protocol_v1_get_info(struct mbox_context *context, |
| 78 | struct protocol_get_info *io); |
Andrew Jeffery | 91a8745 | 2018-08-07 14:54:14 +0930 | [diff] [blame] | 79 | int protocol_v1_get_flash_info(struct mbox_context *context, |
| 80 | struct protocol_get_flash_info *io); |
Andrew Jeffery | 22fa500 | 2018-08-07 15:22:50 +0930 | [diff] [blame^] | 81 | int protocol_v1_create_read_window(struct mbox_context *context, |
| 82 | struct protocol_create_window *io); |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 83 | |
| 84 | /* Protocol v2 */ |
| 85 | int protocol_v2_get_info(struct mbox_context *context, |
| 86 | struct protocol_get_info *io); |
Andrew Jeffery | 91a8745 | 2018-08-07 14:54:14 +0930 | [diff] [blame] | 87 | int protocol_v2_get_flash_info(struct mbox_context *context, |
| 88 | struct protocol_get_flash_info *io); |
Andrew Jeffery | 22fa500 | 2018-08-07 15:22:50 +0930 | [diff] [blame^] | 89 | int protocol_v2_create_read_window(struct mbox_context *context, |
| 90 | struct protocol_create_window *io); |
Andrew Jeffery | 1e531af | 2018-08-07 13:32:57 +0930 | [diff] [blame] | 91 | |
| 92 | #endif /* PROTOCOL_H */ |