Patrick Venture | c7ca291 | 2018-11-02 11:38:33 -0700 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Patrick Venture | 1cde5f9 | 2018-11-07 08:26:47 -0800 | [diff] [blame] | 3 | #include "data_handler.hpp" |
Patrick Venture | a78e39f | 2018-11-06 18:37:06 -0800 | [diff] [blame] | 4 | #include "image_handler.hpp" |
| 5 | |
Patrick Venture | c7ca291 | 2018-11-02 11:38:33 -0700 | [diff] [blame] | 6 | #include <blobs-ipmid/blobs.hpp> |
Patrick Venture | 192d60f | 2018-11-06 11:11:59 -0800 | [diff] [blame] | 7 | #include <cstdint> |
Patrick Venture | d9fb613 | 2018-11-08 09:56:10 -0800 | [diff] [blame] | 8 | #include <map> |
Patrick Venture | 68cf64f | 2018-11-06 10:46:51 -0800 | [diff] [blame] | 9 | #include <memory> |
Patrick Venture | 148cd65 | 2018-11-06 10:59:47 -0800 | [diff] [blame] | 10 | #include <string> |
| 11 | #include <vector> |
Patrick Venture | c7ca291 | 2018-11-02 11:38:33 -0700 | [diff] [blame] | 12 | |
| 13 | namespace blobs |
| 14 | { |
| 15 | |
Patrick Venture | c7ca291 | 2018-11-02 11:38:33 -0700 | [diff] [blame] | 16 | /** |
Patrick Venture | 2d3a254 | 2018-11-08 09:23:24 -0800 | [diff] [blame] | 17 | * Representation of a session, includes how to read/write data. |
| 18 | */ |
| 19 | struct Session |
| 20 | { |
| 21 | /** Pointer to the correct Data handler interface. (nullptr on BT (or KCS)) |
| 22 | */ |
| 23 | DataInterface* dataHandler; |
| 24 | |
| 25 | /** Pointer to the correct image handler interface. (nullptr on hash |
| 26 | * blob_id) */ |
| 27 | ImageHandlerInterface* imageHandler; |
Patrick Venture | 18235e6 | 2018-11-08 10:21:09 -0800 | [diff] [blame] | 28 | |
| 29 | /** The flags used to open the session. */ |
| 30 | std::uint16_t flags; |
Patrick Venture | 32ba9dd | 2018-11-09 16:22:53 -0800 | [diff] [blame] | 31 | |
| 32 | /** A sesion can be for an image (or tarball) or the hash. */ |
| 33 | enum State |
| 34 | { |
| 35 | open = 0, |
| 36 | closed = 1, |
| 37 | }; |
| 38 | |
| 39 | /** The current state of this session. */ |
| 40 | State state; |
Patrick Venture | 2d3a254 | 2018-11-08 09:23:24 -0800 | [diff] [blame] | 41 | }; |
| 42 | |
Patrick Venture | 18235e6 | 2018-11-08 10:21:09 -0800 | [diff] [blame] | 43 | struct ExtChunkHdr |
| 44 | { |
| 45 | std::uint32_t length; /* Length of the data queued (little endian). */ |
| 46 | } __attribute__((packed)); |
| 47 | |
Patrick Venture | 2d3a254 | 2018-11-08 09:23:24 -0800 | [diff] [blame] | 48 | /** |
Patrick Venture | c7ca291 | 2018-11-02 11:38:33 -0700 | [diff] [blame] | 49 | * Register only one firmware blob handler that will manage all sessions. |
| 50 | */ |
| 51 | class FirmwareBlobHandler : public GenericBlobInterface |
| 52 | { |
| 53 | public: |
Patrick Venture | 05abf7e | 2018-11-09 11:02:56 -0800 | [diff] [blame] | 54 | enum UpdateFlags : std::uint16_t |
Patrick Venture | fc3857b | 2018-11-07 08:14:55 -0800 | [diff] [blame] | 55 | { |
Patrick Venture | 9158dcf | 2018-11-08 09:44:28 -0800 | [diff] [blame] | 56 | ipmi = (1 << 8), /* Expect to send contents over IPMI BlockTransfer. */ |
Patrick Venture | fc3857b | 2018-11-07 08:14:55 -0800 | [diff] [blame] | 57 | p2a = (1 << 9), /* Expect to send contents over P2A bridge. */ |
| 58 | lpc = (1 << 10), /* Expect to send contents over LPC bridge. */ |
| 59 | }; |
| 60 | |
Patrick Venture | 92106df | 2018-11-09 09:26:30 -0800 | [diff] [blame] | 61 | /** The state of the firmware update process. */ |
| 62 | enum UpdateState |
| 63 | { |
| 64 | /** The initial state. */ |
| 65 | notYetStarted = 0, |
| 66 | /** |
| 67 | * The upload process has started, but verification has not started. |
| 68 | */ |
| 69 | uploadInProgress = 1, |
| 70 | /** The verification process has started, no more writes allowed. */ |
| 71 | verificationStarted = 2, |
| 72 | /** The verification process has completed. */ |
| 73 | verificationCompleted = 3, |
| 74 | }; |
| 75 | |
Patrick Venture | 79c08bf | 2018-11-09 15:33:54 -0800 | [diff] [blame^] | 76 | /** The return values for verification. */ |
| 77 | enum VerifyCheckResponses : std::uint8_t |
| 78 | { |
| 79 | running = 0, |
| 80 | success = 1, |
| 81 | failed = 2, |
| 82 | other = 3, |
| 83 | }; |
| 84 | |
Patrick Venture | 137ad2c | 2018-11-06 11:30:43 -0800 | [diff] [blame] | 85 | /** |
| 86 | * Create a FirmwareBlobHandler. |
| 87 | * |
Patrick Venture | 4cceb8e | 2018-11-06 11:56:48 -0800 | [diff] [blame] | 88 | * @param[in] firmwares - list of firmware blob_ids to support. |
Patrick Venture | 1cde5f9 | 2018-11-07 08:26:47 -0800 | [diff] [blame] | 89 | * @param[in] transports - list of transports to support. |
Patrick Venture | 137ad2c | 2018-11-06 11:30:43 -0800 | [diff] [blame] | 90 | */ |
Patrick Venture | 1cde5f9 | 2018-11-07 08:26:47 -0800 | [diff] [blame] | 91 | static std::unique_ptr<GenericBlobInterface> CreateFirmwareBlobHandler( |
| 92 | const std::vector<HandlerPack>& firmwares, |
| 93 | const std::vector<DataHandlerPack>& transports); |
Patrick Venture | 68cf64f | 2018-11-06 10:46:51 -0800 | [diff] [blame] | 94 | |
Patrick Venture | 137ad2c | 2018-11-06 11:30:43 -0800 | [diff] [blame] | 95 | /** |
| 96 | * Create a FirmwareBlobHandler. |
| 97 | * |
Patrick Venture | 1cde5f9 | 2018-11-07 08:26:47 -0800 | [diff] [blame] | 98 | * @param[in] firmwares - list of firmware types and their handlers |
| 99 | * @param[in] blobs - list of blobs_ids to support |
| 100 | * @param[in] transports - list of transport types and their handlers |
| 101 | * @param[in] bitmask - bitmask of transports to support |
Patrick Venture | 137ad2c | 2018-11-06 11:30:43 -0800 | [diff] [blame] | 102 | */ |
Patrick Venture | a78e39f | 2018-11-06 18:37:06 -0800 | [diff] [blame] | 103 | FirmwareBlobHandler(const std::vector<HandlerPack>& firmwares, |
| 104 | const std::vector<std::string>& blobs, |
Patrick Venture | 1cde5f9 | 2018-11-07 08:26:47 -0800 | [diff] [blame] | 105 | const std::vector<DataHandlerPack>& transports, |
| 106 | std::uint16_t bitmask) : |
Patrick Venture | a78e39f | 2018-11-06 18:37:06 -0800 | [diff] [blame] | 107 | handlers(firmwares), |
Patrick Venture | d9fb613 | 2018-11-08 09:56:10 -0800 | [diff] [blame] | 108 | blobIDs(blobs), transports(transports), bitmask(bitmask), activeImage(), |
Patrick Venture | 92106df | 2018-11-09 09:26:30 -0800 | [diff] [blame] | 109 | activeHash(), lookup(), state(UpdateState::notYetStarted) |
Patrick Venture | 148cd65 | 2018-11-06 10:59:47 -0800 | [diff] [blame] | 110 | { |
| 111 | } |
Patrick Venture | c7ca291 | 2018-11-02 11:38:33 -0700 | [diff] [blame] | 112 | ~FirmwareBlobHandler() = default; |
| 113 | FirmwareBlobHandler(const FirmwareBlobHandler&) = default; |
| 114 | FirmwareBlobHandler& operator=(const FirmwareBlobHandler&) = default; |
| 115 | FirmwareBlobHandler(FirmwareBlobHandler&&) = default; |
| 116 | FirmwareBlobHandler& operator=(FirmwareBlobHandler&&) = default; |
| 117 | |
| 118 | bool canHandleBlob(const std::string& path) override; |
| 119 | std::vector<std::string> getBlobIds() override; |
| 120 | bool deleteBlob(const std::string& path) override; |
| 121 | bool stat(const std::string& path, struct BlobMeta* meta) override; |
| 122 | bool open(uint16_t session, uint16_t flags, |
| 123 | const std::string& path) override; |
| 124 | std::vector<uint8_t> read(uint16_t session, uint32_t offset, |
| 125 | uint32_t requestedSize) override; |
| 126 | bool write(uint16_t session, uint32_t offset, |
| 127 | const std::vector<uint8_t>& data) override; |
| 128 | bool writeMeta(uint16_t session, uint32_t offset, |
| 129 | const std::vector<uint8_t>& data) override; |
| 130 | bool commit(uint16_t session, const std::vector<uint8_t>& data) override; |
| 131 | bool close(uint16_t session) override; |
| 132 | bool stat(uint16_t session, struct BlobMeta* meta) override; |
| 133 | bool expire(uint16_t session) override; |
Patrick Venture | 148cd65 | 2018-11-06 10:59:47 -0800 | [diff] [blame] | 134 | |
Patrick Venture | 21be45a | 2018-11-06 12:08:52 -0800 | [diff] [blame] | 135 | static const std::string hashBlobID; |
Patrick Venture | 7b9256f | 2018-11-06 15:06:04 -0800 | [diff] [blame] | 136 | static const std::string activeImageBlobID; |
| 137 | static const std::string activeHashBlobID; |
Patrick Venture | 21be45a | 2018-11-06 12:08:52 -0800 | [diff] [blame] | 138 | |
Patrick Venture | 92106df | 2018-11-09 09:26:30 -0800 | [diff] [blame] | 139 | /** Allow grabbing the current state. */ |
| 140 | UpdateState getCurrentState() const |
| 141 | { |
| 142 | return state; |
| 143 | }; |
| 144 | |
Patrick Venture | 148cd65 | 2018-11-06 10:59:47 -0800 | [diff] [blame] | 145 | private: |
Patrick Venture | a78e39f | 2018-11-06 18:37:06 -0800 | [diff] [blame] | 146 | /** List of handlers by type. */ |
| 147 | std::vector<HandlerPack> handlers; |
| 148 | |
Patrick Venture | c02849b | 2018-11-06 17:31:15 -0800 | [diff] [blame] | 149 | /** Active list of blobIDs. */ |
Patrick Venture | 4cceb8e | 2018-11-06 11:56:48 -0800 | [diff] [blame] | 150 | std::vector<std::string> blobIDs; |
Patrick Venture | c02849b | 2018-11-06 17:31:15 -0800 | [diff] [blame] | 151 | |
Patrick Venture | 1cde5f9 | 2018-11-07 08:26:47 -0800 | [diff] [blame] | 152 | /** List of handlers by transport type. */ |
| 153 | std::vector<DataHandlerPack> transports; |
| 154 | |
Patrick Venture | c02849b | 2018-11-06 17:31:15 -0800 | [diff] [blame] | 155 | /** The bits set indicate what transport mechanisms are supported. */ |
Patrick Venture | 1cde5f9 | 2018-11-07 08:26:47 -0800 | [diff] [blame] | 156 | std::uint16_t bitmask; |
Patrick Venture | c02849b | 2018-11-06 17:31:15 -0800 | [diff] [blame] | 157 | |
Patrick Venture | d9fb613 | 2018-11-08 09:56:10 -0800 | [diff] [blame] | 158 | /** Active image session. */ |
| 159 | Session activeImage; |
| 160 | |
| 161 | /** Active hash session. */ |
| 162 | Session activeHash; |
| 163 | |
| 164 | /** A quick method for looking up a session's mechanisms and details. */ |
| 165 | std::map<std::uint16_t, Session*> lookup; |
| 166 | |
Patrick Venture | 92106df | 2018-11-09 09:26:30 -0800 | [diff] [blame] | 167 | /** The firmware update state. */ |
| 168 | UpdateState state; |
| 169 | |
Patrick Venture | c02849b | 2018-11-06 17:31:15 -0800 | [diff] [blame] | 170 | /** Temporary variable to track whether a blob is open. */ |
| 171 | bool fileOpen = false; |
Patrick Venture | c7ca291 | 2018-11-02 11:38:33 -0700 | [diff] [blame] | 172 | }; |
| 173 | |
| 174 | } // namespace blobs |