xref: /openbmc/linux/lib/pldmfw/pldmfw.c (revision 5e0266f0)
1b8265621SJacob Keller // SPDX-License-Identifier: GPL-2.0
2b8265621SJacob Keller /* Copyright (C) 2018-2019, Intel Corporation. */
3b8265621SJacob Keller 
4b8265621SJacob Keller #include <asm/unaligned.h>
5b8265621SJacob Keller #include <linux/crc32.h>
6b8265621SJacob Keller #include <linux/device.h>
7b8265621SJacob Keller #include <linux/firmware.h>
8b8265621SJacob Keller #include <linux/kernel.h>
9b8265621SJacob Keller #include <linux/module.h>
10b8265621SJacob Keller #include <linux/pci.h>
11b8265621SJacob Keller #include <linux/pldmfw.h>
12b8265621SJacob Keller #include <linux/slab.h>
13b8265621SJacob Keller #include <linux/uuid.h>
14b8265621SJacob Keller 
15b8265621SJacob Keller #include "pldmfw_private.h"
16b8265621SJacob Keller 
17b8265621SJacob Keller /* Internal structure used to store details about the PLDM image file as it is
18b8265621SJacob Keller  * being validated and processed.
19b8265621SJacob Keller  */
20b8265621SJacob Keller struct pldmfw_priv {
21b8265621SJacob Keller 	struct pldmfw *context;
22b8265621SJacob Keller 	const struct firmware *fw;
23b8265621SJacob Keller 
24b8265621SJacob Keller 	/* current offset of firmware image */
25b8265621SJacob Keller 	size_t offset;
26b8265621SJacob Keller 
27b8265621SJacob Keller 	struct list_head records;
28b8265621SJacob Keller 	struct list_head components;
29b8265621SJacob Keller 
30b8265621SJacob Keller 	/* PLDM Firmware Package Header */
31b8265621SJacob Keller 	const struct __pldm_header *header;
32b8265621SJacob Keller 	u16 total_header_size;
33b8265621SJacob Keller 
34b8265621SJacob Keller 	/* length of the component bitmap */
35b8265621SJacob Keller 	u16 component_bitmap_len;
36b8265621SJacob Keller 	u16 bitmap_size;
37b8265621SJacob Keller 
38b8265621SJacob Keller 	/* Start of the component image information */
39b8265621SJacob Keller 	u16 component_count;
40b8265621SJacob Keller 	const u8 *component_start;
41b8265621SJacob Keller 
42b8265621SJacob Keller 	/* Start pf the firmware device id records */
43b8265621SJacob Keller 	const u8 *record_start;
44b8265621SJacob Keller 	u8 record_count;
45b8265621SJacob Keller 
46b8265621SJacob Keller 	/* The CRC at the end of the package header */
47b8265621SJacob Keller 	u32 header_crc;
48b8265621SJacob Keller 
49b8265621SJacob Keller 	struct pldmfw_record *matching_record;
50b8265621SJacob Keller };
51b8265621SJacob Keller 
52b8265621SJacob Keller /**
53b8265621SJacob Keller  * pldm_check_fw_space - Verify that the firmware image has space left
54b8265621SJacob Keller  * @data: pointer to private data
55b8265621SJacob Keller  * @offset: offset to start from
56b8265621SJacob Keller  * @length: length to check for
57b8265621SJacob Keller  *
58b8265621SJacob Keller  * Verify that the firmware data can hold a chunk of bytes with the specified
59b8265621SJacob Keller  * offset and length.
60b8265621SJacob Keller  *
61b8265621SJacob Keller  * Returns: zero on success, or -EFAULT if the image does not have enough
62b8265621SJacob Keller  * space left to fit the expected length.
63b8265621SJacob Keller  */
64b8265621SJacob Keller static int
pldm_check_fw_space(struct pldmfw_priv * data,size_t offset,size_t length)65b8265621SJacob Keller pldm_check_fw_space(struct pldmfw_priv *data, size_t offset, size_t length)
66b8265621SJacob Keller {
67b8265621SJacob Keller 	size_t expected_size = offset + length;
68b8265621SJacob Keller 	struct device *dev = data->context->dev;
69b8265621SJacob Keller 
70b8265621SJacob Keller 	if (data->fw->size < expected_size) {
71b8265621SJacob Keller 		dev_dbg(dev, "Firmware file size smaller than expected. Got %zu bytes, needed %zu bytes\n",
72b8265621SJacob Keller 			data->fw->size, expected_size);
73b8265621SJacob Keller 		return -EFAULT;
74b8265621SJacob Keller 	}
75b8265621SJacob Keller 
76b8265621SJacob Keller 	return 0;
77b8265621SJacob Keller }
78b8265621SJacob Keller 
79b8265621SJacob Keller /**
80b8265621SJacob Keller  * pldm_move_fw_offset - Move the current firmware offset forward
81b8265621SJacob Keller  * @data: pointer to private data
82b8265621SJacob Keller  * @bytes_to_move: number of bytes to move the offset forward by
83b8265621SJacob Keller  *
84b8265621SJacob Keller  * Check that there is enough space past the current offset, and then move the
85*9dbbc3b9SZhen Lei  * offset forward by this amount.
86b8265621SJacob Keller  *
87b8265621SJacob Keller  * Returns: zero on success, or -EFAULT if the image is too small to fit the
88b8265621SJacob Keller  * expected length.
89b8265621SJacob Keller  */
90b8265621SJacob Keller static int
pldm_move_fw_offset(struct pldmfw_priv * data,size_t bytes_to_move)91b8265621SJacob Keller pldm_move_fw_offset(struct pldmfw_priv *data, size_t bytes_to_move)
92b8265621SJacob Keller {
93b8265621SJacob Keller 	int err;
94b8265621SJacob Keller 
95b8265621SJacob Keller 	err = pldm_check_fw_space(data, data->offset, bytes_to_move);
96b8265621SJacob Keller 	if (err)
97b8265621SJacob Keller 		return err;
98b8265621SJacob Keller 
99b8265621SJacob Keller 	data->offset += bytes_to_move;
100b8265621SJacob Keller 
101b8265621SJacob Keller 	return 0;
102b8265621SJacob Keller }
103b8265621SJacob Keller 
104b8265621SJacob Keller /**
105b8265621SJacob Keller  * pldm_parse_header - Validate and extract details about the PLDM header
106b8265621SJacob Keller  * @data: pointer to private data
107b8265621SJacob Keller  *
108b8265621SJacob Keller  * Performs initial basic verification of the PLDM image, up to the first
109b8265621SJacob Keller  * firmware record.
110b8265621SJacob Keller  *
111b8265621SJacob Keller  * This includes the following checks and extractions
112b8265621SJacob Keller  *
113b8265621SJacob Keller  *   * Verify that the UUID at the start of the header matches the expected
114b8265621SJacob Keller  *     value as defined in the DSP0267 PLDM specification
115b8265621SJacob Keller  *   * Check that the revision is 0x01
116b8265621SJacob Keller  *   * Extract the total header_size and verify that the image is large enough
117b8265621SJacob Keller  *     to contain at least the length of this header
118b8265621SJacob Keller  *   * Extract the size of the component bitmap length
119b8265621SJacob Keller  *   * Extract a pointer to the start of the record area
120b8265621SJacob Keller  *
121b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
122b8265621SJacob Keller  */
pldm_parse_header(struct pldmfw_priv * data)123b8265621SJacob Keller static int pldm_parse_header(struct pldmfw_priv *data)
124b8265621SJacob Keller {
125b8265621SJacob Keller 	const struct __pldmfw_record_area *record_area;
126b8265621SJacob Keller 	struct device *dev = data->context->dev;
127b8265621SJacob Keller 	const struct __pldm_header *header;
128b8265621SJacob Keller 	size_t header_size;
129b8265621SJacob Keller 	int err;
130b8265621SJacob Keller 
131b8265621SJacob Keller 	err = pldm_move_fw_offset(data, sizeof(*header));
132b8265621SJacob Keller 	if (err)
133b8265621SJacob Keller 		return err;
134b8265621SJacob Keller 
135b8265621SJacob Keller 	header = (const struct __pldm_header *)data->fw->data;
136b8265621SJacob Keller 	data->header = header;
137b8265621SJacob Keller 
138b8265621SJacob Keller 	if (!uuid_equal(&header->id, &pldm_firmware_header_id)) {
139b8265621SJacob Keller 		dev_dbg(dev, "Invalid package header identifier. Expected UUID %pUB, but got %pUB\n",
140b8265621SJacob Keller 			&pldm_firmware_header_id, &header->id);
141b8265621SJacob Keller 		return -EINVAL;
142b8265621SJacob Keller 	}
143b8265621SJacob Keller 
144b8265621SJacob Keller 	if (header->revision != PACKAGE_HEADER_FORMAT_REVISION) {
145b8265621SJacob Keller 		dev_dbg(dev, "Invalid package header revision. Expected revision %u but got %u\n",
146b8265621SJacob Keller 			PACKAGE_HEADER_FORMAT_REVISION, header->revision);
147b8265621SJacob Keller 		return -EOPNOTSUPP;
148b8265621SJacob Keller 	}
149b8265621SJacob Keller 
150b8265621SJacob Keller 	data->total_header_size = get_unaligned_le16(&header->size);
151b8265621SJacob Keller 	header_size = data->total_header_size - sizeof(*header);
152b8265621SJacob Keller 
153b8265621SJacob Keller 	err = pldm_check_fw_space(data, data->offset, header_size);
154b8265621SJacob Keller 	if (err)
155b8265621SJacob Keller 		return err;
156b8265621SJacob Keller 
157b8265621SJacob Keller 	data->component_bitmap_len =
158b8265621SJacob Keller 		get_unaligned_le16(&header->component_bitmap_len);
159b8265621SJacob Keller 
160b8265621SJacob Keller 	if (data->component_bitmap_len % 8 != 0) {
161b8265621SJacob Keller 		dev_dbg(dev, "Invalid component bitmap length. The length is %u, which is not a multiple of 8\n",
162b8265621SJacob Keller 			data->component_bitmap_len);
163b8265621SJacob Keller 		return -EINVAL;
164b8265621SJacob Keller 	}
165b8265621SJacob Keller 
166b8265621SJacob Keller 	data->bitmap_size = data->component_bitmap_len / 8;
167b8265621SJacob Keller 
168b8265621SJacob Keller 	err = pldm_move_fw_offset(data, header->version_len);
169b8265621SJacob Keller 	if (err)
170b8265621SJacob Keller 		return err;
171b8265621SJacob Keller 
172b8265621SJacob Keller 	/* extract a pointer to the record area, which just follows the main
173b8265621SJacob Keller 	 * PLDM header data.
174b8265621SJacob Keller 	 */
175b8265621SJacob Keller 	record_area = (const struct __pldmfw_record_area *)(data->fw->data +
176b8265621SJacob Keller 							 data->offset);
177b8265621SJacob Keller 
178b8265621SJacob Keller 	err = pldm_move_fw_offset(data, sizeof(*record_area));
179b8265621SJacob Keller 	if (err)
180b8265621SJacob Keller 		return err;
181b8265621SJacob Keller 
182b8265621SJacob Keller 	data->record_count = record_area->record_count;
183b8265621SJacob Keller 	data->record_start = record_area->records;
184b8265621SJacob Keller 
185b8265621SJacob Keller 	return 0;
186b8265621SJacob Keller }
187b8265621SJacob Keller 
188b8265621SJacob Keller /**
189b8265621SJacob Keller  * pldm_check_desc_tlv_len - Check that the length matches expectation
190b8265621SJacob Keller  * @data: pointer to image details
191b8265621SJacob Keller  * @type: the descriptor type
192b8265621SJacob Keller  * @size: the length from the descriptor header
193b8265621SJacob Keller  *
194b8265621SJacob Keller  * If the descriptor type is one of the documented descriptor types according
195b8265621SJacob Keller  * to the standard, verify that the provided length matches.
196b8265621SJacob Keller  *
197b8265621SJacob Keller  * If the type is not recognized or is VENDOR_DEFINED, return zero.
198b8265621SJacob Keller  *
199b8265621SJacob Keller  * Returns: zero on success, or -EINVAL if the specified size of a standard
200b8265621SJacob Keller  * TLV does not match the expected value defined for that TLV.
201b8265621SJacob Keller  */
202b8265621SJacob Keller static int
pldm_check_desc_tlv_len(struct pldmfw_priv * data,u16 type,u16 size)203b8265621SJacob Keller pldm_check_desc_tlv_len(struct pldmfw_priv *data, u16 type, u16 size)
204b8265621SJacob Keller {
205b8265621SJacob Keller 	struct device *dev = data->context->dev;
206b8265621SJacob Keller 	u16 expected_size;
207b8265621SJacob Keller 
208b8265621SJacob Keller 	switch (type) {
209b8265621SJacob Keller 	case PLDM_DESC_ID_PCI_VENDOR_ID:
210b8265621SJacob Keller 	case PLDM_DESC_ID_PCI_DEVICE_ID:
211b8265621SJacob Keller 	case PLDM_DESC_ID_PCI_SUBVENDOR_ID:
212b8265621SJacob Keller 	case PLDM_DESC_ID_PCI_SUBDEV_ID:
213b8265621SJacob Keller 		expected_size = 2;
214b8265621SJacob Keller 		break;
215b8265621SJacob Keller 	case PLDM_DESC_ID_PCI_REVISION_ID:
216b8265621SJacob Keller 		expected_size = 1;
217b8265621SJacob Keller 		break;
218b8265621SJacob Keller 	case PLDM_DESC_ID_PNP_VENDOR_ID:
219b8265621SJacob Keller 		expected_size = 3;
220b8265621SJacob Keller 		break;
221b8265621SJacob Keller 	case PLDM_DESC_ID_IANA_ENTERPRISE_ID:
222b8265621SJacob Keller 	case PLDM_DESC_ID_ACPI_VENDOR_ID:
223b8265621SJacob Keller 	case PLDM_DESC_ID_PNP_PRODUCT_ID:
224b8265621SJacob Keller 	case PLDM_DESC_ID_ACPI_PRODUCT_ID:
225b8265621SJacob Keller 		expected_size = 4;
226b8265621SJacob Keller 		break;
227b8265621SJacob Keller 	case PLDM_DESC_ID_UUID:
228b8265621SJacob Keller 		expected_size = 16;
229b8265621SJacob Keller 		break;
230b8265621SJacob Keller 	case PLDM_DESC_ID_VENDOR_DEFINED:
231b8265621SJacob Keller 		return 0;
232b8265621SJacob Keller 	default:
233b8265621SJacob Keller 		/* Do not report an error on an unexpected TLV */
234b8265621SJacob Keller 		dev_dbg(dev, "Found unrecognized TLV type 0x%04x\n", type);
235b8265621SJacob Keller 		return 0;
236b8265621SJacob Keller 	}
237b8265621SJacob Keller 
238b8265621SJacob Keller 	if (size != expected_size) {
239b8265621SJacob Keller 		dev_dbg(dev, "Found TLV type 0x%04x with unexpected length. Got %u bytes, but expected %u bytes\n",
240b8265621SJacob Keller 			type, size, expected_size);
241b8265621SJacob Keller 		return -EINVAL;
242b8265621SJacob Keller 	}
243b8265621SJacob Keller 
244b8265621SJacob Keller 	return 0;
245b8265621SJacob Keller }
246b8265621SJacob Keller 
247b8265621SJacob Keller /**
248b8265621SJacob Keller  * pldm_parse_desc_tlvs - Check and skip past a number of TLVs
249b8265621SJacob Keller  * @data: pointer to private data
250b8265621SJacob Keller  * @record: pointer to the record this TLV belongs too
251b8265621SJacob Keller  * @desc_count: descriptor count
252b8265621SJacob Keller  *
253b8265621SJacob Keller  * From the current offset, read and extract the descriptor TLVs, updating the
254b8265621SJacob Keller  * current offset each time.
255b8265621SJacob Keller  *
256b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
257b8265621SJacob Keller  */
258b8265621SJacob Keller static int
pldm_parse_desc_tlvs(struct pldmfw_priv * data,struct pldmfw_record * record,u8 desc_count)259b8265621SJacob Keller pldm_parse_desc_tlvs(struct pldmfw_priv *data, struct pldmfw_record *record, u8 desc_count)
260b8265621SJacob Keller {
261b8265621SJacob Keller 	const struct __pldmfw_desc_tlv *__desc;
262b8265621SJacob Keller 	const u8 *desc_start;
263b8265621SJacob Keller 	u8 i;
264b8265621SJacob Keller 
265b8265621SJacob Keller 	desc_start = data->fw->data + data->offset;
266b8265621SJacob Keller 
267b8265621SJacob Keller 	pldm_for_each_desc_tlv(i, __desc, desc_start, desc_count) {
268b8265621SJacob Keller 		struct pldmfw_desc_tlv *desc;
269b8265621SJacob Keller 		int err;
270b8265621SJacob Keller 		u16 type, size;
271b8265621SJacob Keller 
272b8265621SJacob Keller 		err = pldm_move_fw_offset(data, sizeof(*__desc));
273b8265621SJacob Keller 		if (err)
274b8265621SJacob Keller 			return err;
275b8265621SJacob Keller 
276b8265621SJacob Keller 		type = get_unaligned_le16(&__desc->type);
277b8265621SJacob Keller 
278b8265621SJacob Keller 		/* According to DSP0267, this only includes the data field */
279b8265621SJacob Keller 		size = get_unaligned_le16(&__desc->size);
280b8265621SJacob Keller 
281b8265621SJacob Keller 		err = pldm_check_desc_tlv_len(data, type, size);
282b8265621SJacob Keller 		if (err)
283b8265621SJacob Keller 			return err;
284b8265621SJacob Keller 
285b8265621SJacob Keller 		/* check that we have space and move the offset forward */
286b8265621SJacob Keller 		err = pldm_move_fw_offset(data, size);
287b8265621SJacob Keller 		if (err)
288b8265621SJacob Keller 			return err;
289b8265621SJacob Keller 
290b8265621SJacob Keller 		desc = kzalloc(sizeof(*desc), GFP_KERNEL);
291b8265621SJacob Keller 		if (!desc)
292b8265621SJacob Keller 			return -ENOMEM;
293b8265621SJacob Keller 
294b8265621SJacob Keller 		desc->type = type;
295b8265621SJacob Keller 		desc->size = size;
296b8265621SJacob Keller 		desc->data = __desc->data;
297b8265621SJacob Keller 
298b8265621SJacob Keller 		list_add_tail(&desc->entry, &record->descs);
299b8265621SJacob Keller 	}
300b8265621SJacob Keller 
301b8265621SJacob Keller 	return 0;
302b8265621SJacob Keller }
303b8265621SJacob Keller 
304b8265621SJacob Keller /**
305b8265621SJacob Keller  * pldm_parse_one_record - Verify size of one PLDM record
306b8265621SJacob Keller  * @data: pointer to image details
307b8265621SJacob Keller  * @__record: pointer to the record to check
308b8265621SJacob Keller  *
309b8265621SJacob Keller  * This function checks that the record size does not exceed either the size
310b8265621SJacob Keller  * of the firmware file or the total length specified in the header section.
311b8265621SJacob Keller  *
312b8265621SJacob Keller  * It also verifies that the recorded length of the start of the record
313b8265621SJacob Keller  * matches the size calculated by adding the static structure length, the
314b8265621SJacob Keller  * component bitmap length, the version string length, the length of all
315b8265621SJacob Keller  * descriptor TLVs, and the length of the package data.
316b8265621SJacob Keller  *
317b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
318b8265621SJacob Keller  */
319b8265621SJacob Keller static int
pldm_parse_one_record(struct pldmfw_priv * data,const struct __pldmfw_record_info * __record)320b8265621SJacob Keller pldm_parse_one_record(struct pldmfw_priv *data,
321b8265621SJacob Keller 		      const struct __pldmfw_record_info *__record)
322b8265621SJacob Keller {
323b8265621SJacob Keller 	struct pldmfw_record *record;
324b8265621SJacob Keller 	size_t measured_length;
325b8265621SJacob Keller 	int err;
326b8265621SJacob Keller 	const u8 *bitmap_ptr;
327b8265621SJacob Keller 	u16 record_len;
328b8265621SJacob Keller 	int i;
329b8265621SJacob Keller 
330b8265621SJacob Keller 	/* Make a copy and insert it into the record list */
331b8265621SJacob Keller 	record = kzalloc(sizeof(*record), GFP_KERNEL);
332b8265621SJacob Keller 	if (!record)
333b8265621SJacob Keller 		return -ENOMEM;
334b8265621SJacob Keller 
335b8265621SJacob Keller 	INIT_LIST_HEAD(&record->descs);
336b8265621SJacob Keller 	list_add_tail(&record->entry, &data->records);
337b8265621SJacob Keller 
338b8265621SJacob Keller 	/* Then check that we have space and move the offset */
339b8265621SJacob Keller 	err = pldm_move_fw_offset(data, sizeof(*__record));
340b8265621SJacob Keller 	if (err)
341b8265621SJacob Keller 		return err;
342b8265621SJacob Keller 
343b8265621SJacob Keller 	record_len = get_unaligned_le16(&__record->record_len);
344b8265621SJacob Keller 	record->package_data_len = get_unaligned_le16(&__record->package_data_len);
345b8265621SJacob Keller 	record->version_len = __record->version_len;
346b8265621SJacob Keller 	record->version_type = __record->version_type;
347b8265621SJacob Keller 
348b8265621SJacob Keller 	bitmap_ptr = data->fw->data + data->offset;
349b8265621SJacob Keller 
350b8265621SJacob Keller 	/* check that we have space for the component bitmap length */
351b8265621SJacob Keller 	err = pldm_move_fw_offset(data, data->bitmap_size);
352b8265621SJacob Keller 	if (err)
353b8265621SJacob Keller 		return err;
354b8265621SJacob Keller 
355b8265621SJacob Keller 	record->component_bitmap_len = data->component_bitmap_len;
356b8265621SJacob Keller 	record->component_bitmap = bitmap_zalloc(record->component_bitmap_len,
357b8265621SJacob Keller 						 GFP_KERNEL);
358b8265621SJacob Keller 	if (!record->component_bitmap)
359b8265621SJacob Keller 		return -ENOMEM;
360b8265621SJacob Keller 
361b8265621SJacob Keller 	for (i = 0; i < data->bitmap_size; i++)
362b8265621SJacob Keller 		bitmap_set_value8(record->component_bitmap, bitmap_ptr[i], i * 8);
363b8265621SJacob Keller 
364b8265621SJacob Keller 	record->version_string = data->fw->data + data->offset;
365b8265621SJacob Keller 
366b8265621SJacob Keller 	err = pldm_move_fw_offset(data, record->version_len);
367b8265621SJacob Keller 	if (err)
368b8265621SJacob Keller 		return err;
369b8265621SJacob Keller 
370b8265621SJacob Keller 	/* Scan through the descriptor TLVs and find the end */
371b8265621SJacob Keller 	err = pldm_parse_desc_tlvs(data, record, __record->descriptor_count);
372b8265621SJacob Keller 	if (err)
373b8265621SJacob Keller 		return err;
374b8265621SJacob Keller 
375b8265621SJacob Keller 	record->package_data = data->fw->data + data->offset;
376b8265621SJacob Keller 
377b8265621SJacob Keller 	err = pldm_move_fw_offset(data, record->package_data_len);
378b8265621SJacob Keller 	if (err)
379b8265621SJacob Keller 		return err;
380b8265621SJacob Keller 
381b8265621SJacob Keller 	measured_length = data->offset - ((const u8 *)__record - data->fw->data);
382b8265621SJacob Keller 	if (measured_length != record_len) {
383b8265621SJacob Keller 		dev_dbg(data->context->dev, "Unexpected record length. Measured record length is %zu bytes, expected length is %u bytes\n",
384b8265621SJacob Keller 			measured_length, record_len);
385b8265621SJacob Keller 		return -EFAULT;
386b8265621SJacob Keller 	}
387b8265621SJacob Keller 
388b8265621SJacob Keller 	return 0;
389b8265621SJacob Keller }
390b8265621SJacob Keller 
391b8265621SJacob Keller /**
392b8265621SJacob Keller  * pldm_parse_records - Locate the start of the component area
393b8265621SJacob Keller  * @data: pointer to private data
394b8265621SJacob Keller  *
395b8265621SJacob Keller  * Extract the record count, and loop through each record, searching for the
396b8265621SJacob Keller  * component area.
397b8265621SJacob Keller  *
398b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
399b8265621SJacob Keller  */
pldm_parse_records(struct pldmfw_priv * data)400b8265621SJacob Keller static int pldm_parse_records(struct pldmfw_priv *data)
401b8265621SJacob Keller {
402b8265621SJacob Keller 	const struct __pldmfw_component_area *component_area;
403b8265621SJacob Keller 	const struct __pldmfw_record_info *record;
404b8265621SJacob Keller 	int err;
405b8265621SJacob Keller 	u8 i;
406b8265621SJacob Keller 
407b8265621SJacob Keller 	pldm_for_each_record(i, record, data->record_start, data->record_count) {
408b8265621SJacob Keller 		err = pldm_parse_one_record(data, record);
409b8265621SJacob Keller 		if (err)
410b8265621SJacob Keller 			return err;
411b8265621SJacob Keller 	}
412b8265621SJacob Keller 
413b8265621SJacob Keller 	/* Extract a pointer to the component area, which just follows the
414b8265621SJacob Keller 	 * PLDM device record data.
415b8265621SJacob Keller 	 */
416b8265621SJacob Keller 	component_area = (const struct __pldmfw_component_area *)(data->fw->data + data->offset);
417b8265621SJacob Keller 
418b8265621SJacob Keller 	err = pldm_move_fw_offset(data, sizeof(*component_area));
419b8265621SJacob Keller 	if (err)
420b8265621SJacob Keller 		return err;
421b8265621SJacob Keller 
422b8265621SJacob Keller 	data->component_count =
423b8265621SJacob Keller 		get_unaligned_le16(&component_area->component_image_count);
424b8265621SJacob Keller 	data->component_start = component_area->components;
425b8265621SJacob Keller 
426b8265621SJacob Keller 	return 0;
427b8265621SJacob Keller }
428b8265621SJacob Keller 
429b8265621SJacob Keller /**
430b8265621SJacob Keller  * pldm_parse_components - Locate the CRC header checksum
431b8265621SJacob Keller  * @data: pointer to private data
432b8265621SJacob Keller  *
433b8265621SJacob Keller  * Extract the component count, and find the pointer to the component area.
434b8265621SJacob Keller  * Scan through each component searching for the end, which should point to
435b8265621SJacob Keller  * the package header checksum.
436b8265621SJacob Keller  *
437b8265621SJacob Keller  * Extract the package header CRC and save it for verification.
438b8265621SJacob Keller  *
439b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
440b8265621SJacob Keller  */
pldm_parse_components(struct pldmfw_priv * data)441b8265621SJacob Keller static int pldm_parse_components(struct pldmfw_priv *data)
442b8265621SJacob Keller {
443b8265621SJacob Keller 	const struct __pldmfw_component_info *__component;
444b8265621SJacob Keller 	struct device *dev = data->context->dev;
445b8265621SJacob Keller 	const u8 *header_crc_ptr;
446b8265621SJacob Keller 	int err;
447b8265621SJacob Keller 	u8 i;
448b8265621SJacob Keller 
449b8265621SJacob Keller 	pldm_for_each_component(i, __component, data->component_start, data->component_count) {
450b8265621SJacob Keller 		struct pldmfw_component *component;
451b8265621SJacob Keller 		u32 offset, size;
452b8265621SJacob Keller 
453b8265621SJacob Keller 		err = pldm_move_fw_offset(data, sizeof(*__component));
454b8265621SJacob Keller 		if (err)
455b8265621SJacob Keller 			return err;
456b8265621SJacob Keller 
457b8265621SJacob Keller 		err = pldm_move_fw_offset(data, __component->version_len);
458b8265621SJacob Keller 		if (err)
459b8265621SJacob Keller 			return err;
460b8265621SJacob Keller 
461b8265621SJacob Keller 		offset = get_unaligned_le32(&__component->location_offset);
462b8265621SJacob Keller 		size = get_unaligned_le32(&__component->size);
463b8265621SJacob Keller 
464b8265621SJacob Keller 		err = pldm_check_fw_space(data, offset, size);
465b8265621SJacob Keller 		if (err)
466b8265621SJacob Keller 			return err;
467b8265621SJacob Keller 
468b8265621SJacob Keller 		component = kzalloc(sizeof(*component), GFP_KERNEL);
469b8265621SJacob Keller 		if (!component)
470b8265621SJacob Keller 			return -ENOMEM;
471b8265621SJacob Keller 
472b8265621SJacob Keller 		component->index = i;
473b8265621SJacob Keller 		component->classification = get_unaligned_le16(&__component->classification);
474b8265621SJacob Keller 		component->identifier = get_unaligned_le16(&__component->identifier);
475b8265621SJacob Keller 		component->comparison_stamp = get_unaligned_le32(&__component->comparison_stamp);
476b8265621SJacob Keller 		component->options = get_unaligned_le16(&__component->options);
477b8265621SJacob Keller 		component->activation_method = get_unaligned_le16(&__component->activation_method);
478b8265621SJacob Keller 		component->version_type = __component->version_type;
479b8265621SJacob Keller 		component->version_len = __component->version_len;
480b8265621SJacob Keller 		component->version_string = __component->version_string;
481b8265621SJacob Keller 		component->component_data = data->fw->data + offset;
482b8265621SJacob Keller 		component->component_size = size;
483b8265621SJacob Keller 
484b8265621SJacob Keller 		list_add_tail(&component->entry, &data->components);
485b8265621SJacob Keller 	}
486b8265621SJacob Keller 
487b8265621SJacob Keller 	header_crc_ptr = data->fw->data + data->offset;
488b8265621SJacob Keller 
489b8265621SJacob Keller 	err = pldm_move_fw_offset(data, sizeof(data->header_crc));
490b8265621SJacob Keller 	if (err)
491b8265621SJacob Keller 		return err;
492b8265621SJacob Keller 
493b8265621SJacob Keller 	/* Make sure that we reached the expected offset */
494b8265621SJacob Keller 	if (data->offset != data->total_header_size) {
495b8265621SJacob Keller 		dev_dbg(dev, "Invalid firmware header size. Expected %u but got %zu\n",
496b8265621SJacob Keller 			data->total_header_size, data->offset);
497b8265621SJacob Keller 		return -EFAULT;
498b8265621SJacob Keller 	}
499b8265621SJacob Keller 
500b8265621SJacob Keller 	data->header_crc = get_unaligned_le32(header_crc_ptr);
501b8265621SJacob Keller 
502b8265621SJacob Keller 	return 0;
503b8265621SJacob Keller }
504b8265621SJacob Keller 
505b8265621SJacob Keller /**
506b8265621SJacob Keller  * pldm_verify_header_crc - Verify that the CRC in the header matches
507b8265621SJacob Keller  * @data: pointer to private data
508b8265621SJacob Keller  *
509b8265621SJacob Keller  * Calculates the 32-bit CRC using the standard IEEE 802.3 CRC polynomial and
510b8265621SJacob Keller  * compares it to the value stored in the header.
511b8265621SJacob Keller  *
512b8265621SJacob Keller  * Returns: zero on success if the CRC matches, or -EBADMSG on an invalid CRC.
513b8265621SJacob Keller  */
pldm_verify_header_crc(struct pldmfw_priv * data)514b8265621SJacob Keller static int pldm_verify_header_crc(struct pldmfw_priv *data)
515b8265621SJacob Keller {
516b8265621SJacob Keller 	struct device *dev = data->context->dev;
517b8265621SJacob Keller 	u32 calculated_crc;
518b8265621SJacob Keller 	size_t length;
519b8265621SJacob Keller 
520b8265621SJacob Keller 	/* Calculate the 32-bit CRC of the header header contents up to but
521b8265621SJacob Keller 	 * not including the checksum. Note that the Linux crc32_le function
522b8265621SJacob Keller 	 * does not perform an expected final XOR.
523b8265621SJacob Keller 	 */
524b8265621SJacob Keller 	length = data->offset - sizeof(data->header_crc);
525b8265621SJacob Keller 	calculated_crc = crc32_le(~0, data->fw->data, length) ^ ~0;
526b8265621SJacob Keller 
527b8265621SJacob Keller 	if (calculated_crc != data->header_crc) {
528b8265621SJacob Keller 		dev_dbg(dev, "Invalid CRC in firmware header. Got 0x%08x but expected 0x%08x\n",
529b8265621SJacob Keller 			calculated_crc, data->header_crc);
530b8265621SJacob Keller 		return -EBADMSG;
531b8265621SJacob Keller 	}
532b8265621SJacob Keller 
533b8265621SJacob Keller 	return 0;
534b8265621SJacob Keller }
535b8265621SJacob Keller 
536b8265621SJacob Keller /**
537b8265621SJacob Keller  * pldmfw_free_priv - Free memory allocated while parsing the PLDM image
538b8265621SJacob Keller  * @data: pointer to the PLDM data structure
539b8265621SJacob Keller  *
540b8265621SJacob Keller  * Loops through and clears all allocated memory associated with each
541b8265621SJacob Keller  * allocated descriptor, record, and component.
542b8265621SJacob Keller  */
pldmfw_free_priv(struct pldmfw_priv * data)543b8265621SJacob Keller static void pldmfw_free_priv(struct pldmfw_priv *data)
544b8265621SJacob Keller {
545b8265621SJacob Keller 	struct pldmfw_component *component, *c_safe;
546b8265621SJacob Keller 	struct pldmfw_record *record, *r_safe;
547b8265621SJacob Keller 	struct pldmfw_desc_tlv *desc, *d_safe;
548b8265621SJacob Keller 
549b8265621SJacob Keller 	list_for_each_entry_safe(component, c_safe, &data->components, entry) {
550b8265621SJacob Keller 		list_del(&component->entry);
551b8265621SJacob Keller 		kfree(component);
552b8265621SJacob Keller 	}
553b8265621SJacob Keller 
554b8265621SJacob Keller 	list_for_each_entry_safe(record, r_safe, &data->records, entry) {
555b8265621SJacob Keller 		list_for_each_entry_safe(desc, d_safe, &record->descs, entry) {
556b8265621SJacob Keller 			list_del(&desc->entry);
557b8265621SJacob Keller 			kfree(desc);
558b8265621SJacob Keller 		}
559b8265621SJacob Keller 
560b8265621SJacob Keller 		if (record->component_bitmap) {
561b8265621SJacob Keller 			bitmap_free(record->component_bitmap);
562b8265621SJacob Keller 			record->component_bitmap = NULL;
563b8265621SJacob Keller 		}
564b8265621SJacob Keller 
565b8265621SJacob Keller 		list_del(&record->entry);
566b8265621SJacob Keller 		kfree(record);
567b8265621SJacob Keller 	}
568b8265621SJacob Keller }
569b8265621SJacob Keller 
570b8265621SJacob Keller /**
571b8265621SJacob Keller  * pldm_parse_image - parse and extract details from PLDM image
572b8265621SJacob Keller  * @data: pointer to private data
573b8265621SJacob Keller  *
574b8265621SJacob Keller  * Verify that the firmware file contains valid data for a PLDM firmware
575b8265621SJacob Keller  * file. Extract useful pointers and data from the firmware file and store
576b8265621SJacob Keller  * them in the data structure.
577b8265621SJacob Keller  *
578b8265621SJacob Keller  * The PLDM firmware file format is defined in DMTF DSP0267 1.0.0. Care
579b8265621SJacob Keller  * should be taken to use get_unaligned_le* when accessing data from the
580b8265621SJacob Keller  * pointers in data.
581b8265621SJacob Keller  *
582b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
583b8265621SJacob Keller  */
pldm_parse_image(struct pldmfw_priv * data)584b8265621SJacob Keller static int pldm_parse_image(struct pldmfw_priv *data)
585b8265621SJacob Keller {
586b8265621SJacob Keller 	int err;
587b8265621SJacob Keller 
588b8265621SJacob Keller 	if (WARN_ON(!(data->context->dev && data->fw->data && data->fw->size)))
589b8265621SJacob Keller 		return -EINVAL;
590b8265621SJacob Keller 
591b8265621SJacob Keller 	err = pldm_parse_header(data);
592b8265621SJacob Keller 	if (err)
593b8265621SJacob Keller 		return err;
594b8265621SJacob Keller 
595b8265621SJacob Keller 	err = pldm_parse_records(data);
596b8265621SJacob Keller 	if (err)
597b8265621SJacob Keller 		return err;
598b8265621SJacob Keller 
599b8265621SJacob Keller 	err = pldm_parse_components(data);
600b8265621SJacob Keller 	if (err)
601b8265621SJacob Keller 		return err;
602b8265621SJacob Keller 
603b8265621SJacob Keller 	return pldm_verify_header_crc(data);
604b8265621SJacob Keller }
605b8265621SJacob Keller 
606b8265621SJacob Keller /* these are u32 so that we can store PCI_ANY_ID */
607b8265621SJacob Keller struct pldm_pci_record_id {
608b8265621SJacob Keller 	int vendor;
609b8265621SJacob Keller 	int device;
610b8265621SJacob Keller 	int subsystem_vendor;
611b8265621SJacob Keller 	int subsystem_device;
612b8265621SJacob Keller };
613b8265621SJacob Keller 
614b8265621SJacob Keller /**
615b8265621SJacob Keller  * pldmfw_op_pci_match_record - Check if a PCI device matches the record
616b8265621SJacob Keller  * @context: PLDM fw update structure
617b8265621SJacob Keller  * @record: list of records extracted from the PLDM image
618b8265621SJacob Keller  *
619b8265621SJacob Keller  * Determine of the PCI device associated with this device matches the record
620b8265621SJacob Keller  * data provided.
621b8265621SJacob Keller  *
622b8265621SJacob Keller  * Searches the descriptor TLVs and extracts the relevant descriptor data into
623b8265621SJacob Keller  * a pldm_pci_record_id. This is then compared against the PCI device ID
624b8265621SJacob Keller  * information.
625b8265621SJacob Keller  *
626b8265621SJacob Keller  * Returns: true if the device matches the record, false otherwise.
627b8265621SJacob Keller  */
pldmfw_op_pci_match_record(struct pldmfw * context,struct pldmfw_record * record)628b8265621SJacob Keller bool pldmfw_op_pci_match_record(struct pldmfw *context, struct pldmfw_record *record)
629b8265621SJacob Keller {
630b8265621SJacob Keller 	struct pci_dev *pdev = to_pci_dev(context->dev);
631b8265621SJacob Keller 	struct pldm_pci_record_id id = {
632b8265621SJacob Keller 		.vendor = PCI_ANY_ID,
633b8265621SJacob Keller 		.device = PCI_ANY_ID,
634b8265621SJacob Keller 		.subsystem_vendor = PCI_ANY_ID,
635b8265621SJacob Keller 		.subsystem_device = PCI_ANY_ID,
636b8265621SJacob Keller 	};
637b8265621SJacob Keller 	struct pldmfw_desc_tlv *desc;
638b8265621SJacob Keller 
639b8265621SJacob Keller 	list_for_each_entry(desc, &record->descs, entry) {
640b8265621SJacob Keller 		u16 value;
641b8265621SJacob Keller 		int *ptr;
642b8265621SJacob Keller 
643b8265621SJacob Keller 		switch (desc->type) {
644b8265621SJacob Keller 		case PLDM_DESC_ID_PCI_VENDOR_ID:
645b8265621SJacob Keller 			ptr = &id.vendor;
646b8265621SJacob Keller 			break;
647b8265621SJacob Keller 		case PLDM_DESC_ID_PCI_DEVICE_ID:
648b8265621SJacob Keller 			ptr = &id.device;
649b8265621SJacob Keller 			break;
650b8265621SJacob Keller 		case PLDM_DESC_ID_PCI_SUBVENDOR_ID:
651b8265621SJacob Keller 			ptr = &id.subsystem_vendor;
652b8265621SJacob Keller 			break;
653b8265621SJacob Keller 		case PLDM_DESC_ID_PCI_SUBDEV_ID:
654b8265621SJacob Keller 			ptr = &id.subsystem_device;
655b8265621SJacob Keller 			break;
656b8265621SJacob Keller 		default:
657b8265621SJacob Keller 			/* Skip unrelated TLVs */
658b8265621SJacob Keller 			continue;
659b8265621SJacob Keller 		}
660b8265621SJacob Keller 
661b8265621SJacob Keller 		value = get_unaligned_le16(desc->data);
662b8265621SJacob Keller 		/* A value of zero for one of the descriptors is sometimes
663b8265621SJacob Keller 		 * used when the record should ignore this field when matching
664b8265621SJacob Keller 		 * device. For example if the record applies to any subsystem
665b8265621SJacob Keller 		 * device or vendor.
666b8265621SJacob Keller 		 */
667b8265621SJacob Keller 		if (value)
668b8265621SJacob Keller 			*ptr = (int)value;
669b8265621SJacob Keller 		else
670b8265621SJacob Keller 			*ptr = PCI_ANY_ID;
671b8265621SJacob Keller 	}
672b8265621SJacob Keller 
673b8265621SJacob Keller 	if ((id.vendor == PCI_ANY_ID || id.vendor == pdev->vendor) &&
674b8265621SJacob Keller 	    (id.device == PCI_ANY_ID || id.device == pdev->device) &&
675b8265621SJacob Keller 	    (id.subsystem_vendor == PCI_ANY_ID || id.subsystem_vendor == pdev->subsystem_vendor) &&
676b8265621SJacob Keller 	    (id.subsystem_device == PCI_ANY_ID || id.subsystem_device == pdev->subsystem_device))
677b8265621SJacob Keller 		return true;
678b8265621SJacob Keller 	else
679b8265621SJacob Keller 		return false;
680b8265621SJacob Keller }
681b8265621SJacob Keller EXPORT_SYMBOL(pldmfw_op_pci_match_record);
682b8265621SJacob Keller 
683b8265621SJacob Keller /**
684b8265621SJacob Keller  * pldm_find_matching_record - Find the first matching PLDM record
685b8265621SJacob Keller  * @data: pointer to private data
686b8265621SJacob Keller  *
687b8265621SJacob Keller  * Search through PLDM records and find the first matching entry. It is
688b8265621SJacob Keller  * expected that only one entry matches.
689b8265621SJacob Keller  *
690b8265621SJacob Keller  * Store a pointer to the matching record, if found.
691b8265621SJacob Keller  *
692b8265621SJacob Keller  * Returns: zero on success, or -ENOENT if no matching record is found.
693b8265621SJacob Keller  */
pldm_find_matching_record(struct pldmfw_priv * data)694b8265621SJacob Keller static int pldm_find_matching_record(struct pldmfw_priv *data)
695b8265621SJacob Keller {
696b8265621SJacob Keller 	struct pldmfw_record *record;
697b8265621SJacob Keller 
698b8265621SJacob Keller 	list_for_each_entry(record, &data->records, entry) {
699b8265621SJacob Keller 		if (data->context->ops->match_record(data->context, record)) {
700b8265621SJacob Keller 			data->matching_record = record;
701b8265621SJacob Keller 			return 0;
702b8265621SJacob Keller 		}
703b8265621SJacob Keller 	}
704b8265621SJacob Keller 
705b8265621SJacob Keller 	return -ENOENT;
706b8265621SJacob Keller }
707b8265621SJacob Keller 
708b8265621SJacob Keller /**
709b8265621SJacob Keller  * pldm_send_package_data - Send firmware the package data for the record
710b8265621SJacob Keller  * @data: pointer to private data
711b8265621SJacob Keller  *
712b8265621SJacob Keller  * Send the package data associated with the matching record to the firmware,
713b8265621SJacob Keller  * using the send_pkg_data operation.
714b8265621SJacob Keller  *
715b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
716b8265621SJacob Keller  */
717b8265621SJacob Keller static int
pldm_send_package_data(struct pldmfw_priv * data)718b8265621SJacob Keller pldm_send_package_data(struct pldmfw_priv *data)
719b8265621SJacob Keller {
720b8265621SJacob Keller 	struct pldmfw_record *record = data->matching_record;
721b8265621SJacob Keller 	const struct pldmfw_ops *ops = data->context->ops;
722b8265621SJacob Keller 
723b8265621SJacob Keller 	return ops->send_package_data(data->context, record->package_data,
724b8265621SJacob Keller 				      record->package_data_len);
725b8265621SJacob Keller }
726b8265621SJacob Keller 
727b8265621SJacob Keller /**
728b8265621SJacob Keller  * pldm_send_component_tables - Send component table information to firmware
729b8265621SJacob Keller  * @data: pointer to private data
730b8265621SJacob Keller  *
731b8265621SJacob Keller  * Loop over each component, sending the applicable components to the firmware
732b8265621SJacob Keller  * via the send_component_table operation.
733b8265621SJacob Keller  *
734b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
735b8265621SJacob Keller  */
736b8265621SJacob Keller static int
pldm_send_component_tables(struct pldmfw_priv * data)737b8265621SJacob Keller pldm_send_component_tables(struct pldmfw_priv *data)
738b8265621SJacob Keller {
739b8265621SJacob Keller 	unsigned long *bitmap = data->matching_record->component_bitmap;
740b8265621SJacob Keller 	struct pldmfw_component *component;
741b8265621SJacob Keller 	int err;
742b8265621SJacob Keller 
743b8265621SJacob Keller 	list_for_each_entry(component, &data->components, entry) {
744b8265621SJacob Keller 		u8 index = component->index, transfer_flag = 0;
745b8265621SJacob Keller 
746b8265621SJacob Keller 		/* Skip components which are not intended for this device */
747b8265621SJacob Keller 		if (!test_bit(index, bitmap))
748b8265621SJacob Keller 			continue;
749b8265621SJacob Keller 
750b8265621SJacob Keller 		/* determine whether this is the start, middle, end, or both
751b8265621SJacob Keller 		 * the start and end of the component tables
752b8265621SJacob Keller 		 */
753b8265621SJacob Keller 		if (index == find_first_bit(bitmap, data->component_bitmap_len))
754b8265621SJacob Keller 			transfer_flag |= PLDM_TRANSFER_FLAG_START;
755b8265621SJacob Keller 		if (index == find_last_bit(bitmap, data->component_bitmap_len))
756b8265621SJacob Keller 			transfer_flag |= PLDM_TRANSFER_FLAG_END;
757b8265621SJacob Keller 		if (!transfer_flag)
758b8265621SJacob Keller 			transfer_flag = PLDM_TRANSFER_FLAG_MIDDLE;
759b8265621SJacob Keller 
760b8265621SJacob Keller 		err = data->context->ops->send_component_table(data->context,
761b8265621SJacob Keller 							       component,
762b8265621SJacob Keller 							       transfer_flag);
763b8265621SJacob Keller 		if (err)
764b8265621SJacob Keller 			return err;
765b8265621SJacob Keller 	}
766b8265621SJacob Keller 
767b8265621SJacob Keller 	return 0;
768b8265621SJacob Keller }
769b8265621SJacob Keller 
770b8265621SJacob Keller /**
771b8265621SJacob Keller  * pldm_flash_components - Program each component to device flash
772b8265621SJacob Keller  * @data: pointer to private data
773b8265621SJacob Keller  *
774b8265621SJacob Keller  * Loop through each component that is active for the matching device record,
775b8265621SJacob Keller  * and send it to the device driver for flashing.
776b8265621SJacob Keller  *
777b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
778b8265621SJacob Keller  */
pldm_flash_components(struct pldmfw_priv * data)779b8265621SJacob Keller static int pldm_flash_components(struct pldmfw_priv *data)
780b8265621SJacob Keller {
781b8265621SJacob Keller 	unsigned long *bitmap = data->matching_record->component_bitmap;
782b8265621SJacob Keller 	struct pldmfw_component *component;
783b8265621SJacob Keller 	int err;
784b8265621SJacob Keller 
785b8265621SJacob Keller 	list_for_each_entry(component, &data->components, entry) {
786b8265621SJacob Keller 		u8 index = component->index;
787b8265621SJacob Keller 
788b8265621SJacob Keller 		/* Skip components which are not intended for this device */
789b8265621SJacob Keller 		if (!test_bit(index, bitmap))
790b8265621SJacob Keller 			continue;
791b8265621SJacob Keller 
792b8265621SJacob Keller 		err = data->context->ops->flash_component(data->context, component);
793b8265621SJacob Keller 		if (err)
794b8265621SJacob Keller 			return err;
795b8265621SJacob Keller 	}
796b8265621SJacob Keller 
797b8265621SJacob Keller 	return 0;
798b8265621SJacob Keller }
799b8265621SJacob Keller 
800b8265621SJacob Keller /**
801b8265621SJacob Keller  * pldm_finalize_update - Finalize the device flash update
802b8265621SJacob Keller  * @data: pointer to private data
803b8265621SJacob Keller  *
804b8265621SJacob Keller  * Tell the device driver to perform any remaining logic to complete the
805b8265621SJacob Keller  * device update.
806b8265621SJacob Keller  *
807b8265621SJacob Keller  * Returns: zero on success, or a PLFM_FWU error indicating the reason for
808b8265621SJacob Keller  * failure.
809b8265621SJacob Keller  */
pldm_finalize_update(struct pldmfw_priv * data)810b8265621SJacob Keller static int pldm_finalize_update(struct pldmfw_priv *data)
811b8265621SJacob Keller {
812b8265621SJacob Keller 	if (data->context->ops->finalize_update)
813b8265621SJacob Keller 		return data->context->ops->finalize_update(data->context);
814b8265621SJacob Keller 
815b8265621SJacob Keller 	return 0;
816b8265621SJacob Keller }
817b8265621SJacob Keller 
818b8265621SJacob Keller /**
819b8265621SJacob Keller  * pldmfw_flash_image - Write a PLDM-formatted firmware image to the device
820b8265621SJacob Keller  * @context: ops and data for firmware update
821b8265621SJacob Keller  * @fw: firmware object pointing to the relevant firmware file to program
822b8265621SJacob Keller  *
823b8265621SJacob Keller  * Parse the data for a given firmware file, verifying that it is a valid PLDM
824b8265621SJacob Keller  * formatted image that matches this device.
825b8265621SJacob Keller  *
826b8265621SJacob Keller  * Extract the device record Package Data and Component Tables and send them
827b8265621SJacob Keller  * to the device firmware. Extract and write the flash data for each of the
828b8265621SJacob Keller  * components indicated in the firmware file.
829b8265621SJacob Keller  *
830b8265621SJacob Keller  * Returns: zero on success, or a negative error code on failure.
831b8265621SJacob Keller  */
pldmfw_flash_image(struct pldmfw * context,const struct firmware * fw)832b8265621SJacob Keller int pldmfw_flash_image(struct pldmfw *context, const struct firmware *fw)
833b8265621SJacob Keller {
834b8265621SJacob Keller 	struct pldmfw_priv *data;
835b8265621SJacob Keller 	int err;
836b8265621SJacob Keller 
837b8265621SJacob Keller 	data = kzalloc(sizeof(*data), GFP_KERNEL);
838b8265621SJacob Keller 	if (!data)
839b8265621SJacob Keller 		return -ENOMEM;
840b8265621SJacob Keller 
841b8265621SJacob Keller 	INIT_LIST_HEAD(&data->records);
842b8265621SJacob Keller 	INIT_LIST_HEAD(&data->components);
843b8265621SJacob Keller 
844b8265621SJacob Keller 	data->fw = fw;
845b8265621SJacob Keller 	data->context = context;
846b8265621SJacob Keller 
847b8265621SJacob Keller 	err = pldm_parse_image(data);
848b8265621SJacob Keller 	if (err)
849b8265621SJacob Keller 		goto out_release_data;
850b8265621SJacob Keller 
851b8265621SJacob Keller 	err = pldm_find_matching_record(data);
852b8265621SJacob Keller 	if (err)
853b8265621SJacob Keller 		goto out_release_data;
854b8265621SJacob Keller 
855b8265621SJacob Keller 	err = pldm_send_package_data(data);
856b8265621SJacob Keller 	if (err)
857b8265621SJacob Keller 		goto out_release_data;
858b8265621SJacob Keller 
859b8265621SJacob Keller 	err = pldm_send_component_tables(data);
860b8265621SJacob Keller 	if (err)
861b8265621SJacob Keller 		goto out_release_data;
862b8265621SJacob Keller 
863b8265621SJacob Keller 	err = pldm_flash_components(data);
864b8265621SJacob Keller 	if (err)
865b8265621SJacob Keller 		goto out_release_data;
866b8265621SJacob Keller 
867b8265621SJacob Keller 	err = pldm_finalize_update(data);
868b8265621SJacob Keller 
869b8265621SJacob Keller out_release_data:
870b8265621SJacob Keller 	pldmfw_free_priv(data);
871b8265621SJacob Keller 	kfree(data);
872b8265621SJacob Keller 
873b8265621SJacob Keller 	return err;
874b8265621SJacob Keller }
875b8265621SJacob Keller EXPORT_SYMBOL(pldmfw_flash_image);
876b8265621SJacob Keller 
877b8265621SJacob Keller MODULE_AUTHOR("Jacob Keller <jacob.e.keller@intel.com>");
878b8265621SJacob Keller MODULE_DESCRIPTION("PLDM firmware flash update library");
879