blob: 19a41cf48e6981bbb486d8ca3a68c9dd0d8c3563 [file] [log] [blame]
Nico Huber454f6132012-12-10 13:34:10 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2012, 2016 secunet Security Networks AG
5 * (Written by Nico Huber <nico.huber@secunet.com> for secunet)
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
Nico Huber454f6132012-12-10 13:34:10 +000016 */
17/**
18 * @mainpage
19 *
20 * Have a look at the Modules section for a function reference.
21 */
22
Nico Huber70461a92019-06-15 14:56:19 +020023#include <errno.h>
Nico Huber454f6132012-12-10 13:34:10 +000024#include <stdlib.h>
25#include <string.h>
26#include <stdarg.h>
27
28#include "flash.h"
Arthur Heymansc82900b2018-01-10 12:48:16 +010029#include "fmap.h"
Nico Huber454f6132012-12-10 13:34:10 +000030#include "programmer.h"
31#include "layout.h"
Nico Huber305f4172013-06-14 11:55:26 +020032#include "hwaccess.h"
33#include "ich_descriptors.h"
Nico Huber454f6132012-12-10 13:34:10 +000034#include "libflashrom.h"
Nikolai Artemievda1c8342021-10-21 00:58:12 +110035#include "writeprotect.h"
Nico Huber454f6132012-12-10 13:34:10 +000036
37/**
38 * @defgroup flashrom-general General
39 * @{
40 */
41
42/** Pointer to log callback function. */
43static flashrom_log_callback *global_log_callback = NULL;
44
45/**
46 * @brief Initialize libflashrom.
47 *
48 * @param perform_selfcheck If not zero, perform a self check.
49 * @return 0 on success
50 */
51int flashrom_init(const int perform_selfcheck)
52{
53 if (perform_selfcheck && selfcheck())
54 return 1;
55 myusec_calibrate_delay();
56 return 0;
57}
58
59/**
60 * @brief Shut down libflashrom.
61 * @return 0 on success
62 */
63int flashrom_shutdown(void)
64{
65 return 0; /* TODO: nothing to do? */
66}
67
68/* TODO: flashrom_set_loglevel()? do we need it?
Angel Pons0be623c2021-04-17 17:08:44 +020069 For now, let the user decide in their callback. */
Nico Huber454f6132012-12-10 13:34:10 +000070
71/**
72 * @brief Set the log callback function.
73 *
74 * Set a callback function which will be invoked whenever libflashrom wants
75 * to output messages. This allows frontends to do whatever they see fit with
76 * such messages, e.g. write them to syslog, or to file, or print them in a
77 * GUI window, etc.
78 *
79 * @param log_callback Pointer to the new log callback function.
80 */
81void flashrom_set_log_callback(flashrom_log_callback *const log_callback)
82{
83 global_log_callback = log_callback;
84}
85/** @private */
Nico Huberd152fb92017-06-19 12:57:10 +020086int print(const enum flashrom_log_level level, const char *const fmt, ...)
Nico Huber454f6132012-12-10 13:34:10 +000087{
88 if (global_log_callback) {
89 int ret;
90 va_list args;
91 va_start(args, fmt);
Nico Huberd152fb92017-06-19 12:57:10 +020092 ret = global_log_callback(level, fmt, args);
Nico Huber454f6132012-12-10 13:34:10 +000093 va_end(args);
94 return ret;
95 }
96 return 0;
97}
98
99/** @} */ /* end flashrom-general */
100
101
102
103/**
104 * @defgroup flashrom-query Querying
105 * @{
106 */
107
Nico Huberabfb70c2022-12-22 12:09:36 +0000108/* TBD */
Nico Huber454f6132012-12-10 13:34:10 +0000109
110/** @} */ /* end flashrom-query */
111
112
113
114/**
115 * @defgroup flashrom-prog Programmers
116 * @{
117 */
118
119/**
120 * @brief Initialize the specified programmer.
121 *
122 * Currently, only one programmer may be initialized at a time.
123 *
124 * @param[out] flashprog Points to a pointer of type struct flashrom_programmer
125 * that will be set if programmer initialization succeeds.
126 * *flashprog has to be shutdown by the caller with @ref
127 * flashrom_programmer_shutdown.
128 * @param[in] prog_name Name of the programmer to initialize.
129 * @param[in] prog_param Pointer to programmer specific parameters.
130 * @return 0 on success
131 */
132int flashrom_programmer_init(struct flashrom_programmer **const flashprog,
133 const char *const prog_name, const char *const prog_param)
134{
135 unsigned prog;
136
Thomas Heijligend45cb592021-05-19 14:12:18 +0200137 for (prog = 0; prog < programmer_table_size; prog++) {
Thomas Heijligen633d6db2021-03-31 19:09:44 +0200138 if (strcmp(prog_name, programmer_table[prog]->name) == 0)
Nico Huber454f6132012-12-10 13:34:10 +0000139 break;
140 }
Thomas Heijligend45cb592021-05-19 14:12:18 +0200141 if (prog >= programmer_table_size) {
Nico Huber454f6132012-12-10 13:34:10 +0000142 msg_ginfo("Error: Unknown programmer \"%s\". Valid choices are:\n", prog_name);
143 list_programmers_linebreak(0, 80, 0);
144 return 1;
145 }
Thomas Heijligene0e93cf2021-06-01 14:37:12 +0200146 return programmer_init(programmer_table[prog], prog_param);
Nico Huber454f6132012-12-10 13:34:10 +0000147}
148
149/**
150 * @brief Shut down the initialized programmer.
151 *
152 * @param flashprog The programmer to shut down.
153 * @return 0 on success
154 */
155int flashrom_programmer_shutdown(struct flashrom_programmer *const flashprog)
156{
157 return programmer_shutdown();
158}
159
160/* TODO: flashrom_programmer_capabilities()? */
161
162/** @} */ /* end flashrom-prog */
163
164
165
166/**
167 * @defgroup flashrom-flash Flash chips
168 * @{
169 */
170
171/**
172 * @brief Probe for a flash chip.
173 *
174 * Probes for a flash chip and returns a flash context, that can be used
175 * later with flash chip and @ref flashrom-ops "image operations", if
176 * exactly one matching chip is found.
177 *
178 * @param[out] flashctx Points to a pointer of type struct flashrom_flashctx
179 * that will be set if exactly one chip is found. *flashctx
180 * has to be freed by the caller with @ref flashrom_flash_release.
181 * @param[in] flashprog The flash programmer used to access the chip.
182 * @param[in] chip_name Name of a chip to probe for, or NULL to probe for
183 * all known chips.
184 * @return 0 on success,
185 * 3 if multiple chips were found,
186 * 2 if no chip was found,
187 * or 1 on any other error.
188 */
189int flashrom_flash_probe(struct flashrom_flashctx **const flashctx,
190 const struct flashrom_programmer *const flashprog,
191 const char *const chip_name)
192{
193 int i, ret = 2;
194 struct flashrom_flashctx second_flashctx = { 0, };
195
196 chip_to_probe = chip_name; /* chip_to_probe is global in flashrom.c */
197
198 *flashctx = malloc(sizeof(**flashctx));
199 if (!*flashctx)
200 return 1;
201 memset(*flashctx, 0, sizeof(**flashctx));
202
203 for (i = 0; i < registered_master_count; ++i) {
204 int flash_idx = -1;
205 if (!ret || (flash_idx = probe_flash(&registered_masters[i], 0, *flashctx, 0)) != -1) {
206 ret = 0;
207 /* We found one chip, now check that there is no second match. */
208 if (probe_flash(&registered_masters[i], flash_idx + 1, &second_flashctx, 0) != -1) {
Nico Huber38450ce2019-06-16 20:07:28 +0200209 free(second_flashctx.chip);
Nico Huber454f6132012-12-10 13:34:10 +0000210 ret = 3;
211 break;
212 }
213 }
214 }
215 if (ret) {
216 free(*flashctx);
217 *flashctx = NULL;
218 }
219 return ret;
220}
221
222/**
223 * @brief Returns the size of the specified flash chip in bytes.
224 *
225 * @param flashctx The queried flash context.
226 * @return Size of flash chip in bytes.
227 */
228size_t flashrom_flash_getsize(const struct flashrom_flashctx *const flashctx)
229{
230 return flashctx->chip->total_size * 1024;
231}
232
233/**
234 * @brief Free a flash context.
235 *
236 * @param flashctx Flash context to free.
237 */
238void flashrom_flash_release(struct flashrom_flashctx *const flashctx)
239{
Nico Huber38450ce2019-06-16 20:07:28 +0200240 free(flashctx->chip);
Nico Huber454f6132012-12-10 13:34:10 +0000241 free(flashctx);
242}
243
244/**
245 * @brief Set a flag in the given flash context.
246 *
247 * @param flashctx Flash context to alter.
248 * @param flag Flag that is to be set / cleared.
249 * @param value Value to set.
250 */
251void flashrom_flag_set(struct flashrom_flashctx *const flashctx,
252 const enum flashrom_flag flag, const bool value)
253{
254 switch (flag) {
255 case FLASHROM_FLAG_FORCE: flashctx->flags.force = value; break;
256 case FLASHROM_FLAG_FORCE_BOARDMISMATCH: flashctx->flags.force_boardmismatch = value; break;
257 case FLASHROM_FLAG_VERIFY_AFTER_WRITE: flashctx->flags.verify_after_write = value; break;
258 case FLASHROM_FLAG_VERIFY_WHOLE_CHIP: flashctx->flags.verify_whole_chip = value; break;
259 }
260}
261
262/**
263 * @brief Return the current value of a flag in the given flash context.
264 *
265 * @param flashctx Flash context to read from.
266 * @param flag Flag to be read.
267 * @return Current value of the flag.
268 */
269bool flashrom_flag_get(const struct flashrom_flashctx *const flashctx, const enum flashrom_flag flag)
270{
271 switch (flag) {
272 case FLASHROM_FLAG_FORCE: return flashctx->flags.force;
273 case FLASHROM_FLAG_FORCE_BOARDMISMATCH: return flashctx->flags.force_boardmismatch;
274 case FLASHROM_FLAG_VERIFY_AFTER_WRITE: return flashctx->flags.verify_after_write;
275 case FLASHROM_FLAG_VERIFY_WHOLE_CHIP: return flashctx->flags.verify_whole_chip;
276 default: return false;
277 }
278}
279
280/** @} */ /* end flashrom-flash */
281
282
283
284/**
285 * @defgroup flashrom-layout Layout handling
286 * @{
287 */
288
289/**
Nico Huber305f4172013-06-14 11:55:26 +0200290 * @brief Read a layout from the Intel ICH descriptor in the flash.
291 *
292 * Optionally verify that the layout matches the one in the given
293 * descriptor dump.
294 *
295 * @param[out] layout Points to a struct flashrom_layout pointer that
296 * gets set if the descriptor is read and parsed
297 * successfully.
298 * @param[in] flashctx Flash context to read the descriptor from flash.
299 * @param[in] dump The descriptor dump to compare to or NULL.
300 * @param[in] len The length of the descriptor dump.
301 *
302 * @return 0 on success,
303 * 6 if descriptor parsing isn't implemented for the host,
304 * 5 if the descriptors don't match,
305 * 4 if the descriptor dump couldn't be parsed,
306 * 3 if the descriptor on flash couldn't be parsed,
307 * 2 if the descriptor on flash couldn't be read,
308 * 1 on any other error.
309 */
310int flashrom_layout_read_from_ifd(struct flashrom_layout **const layout, struct flashctx *const flashctx,
311 const void *const dump, const size_t len)
312{
313#ifndef __FLASHROM_LITTLE_ENDIAN__
314 return 6;
315#else
316 struct ich_layout dump_layout;
317 int ret = 1;
318
319 void *const desc = malloc(0x1000);
320 struct ich_layout *const chip_layout = malloc(sizeof(*chip_layout));
321 if (!desc || !chip_layout) {
322 msg_gerr("Out of memory!\n");
323 goto _free_ret;
324 }
325
326 if (prepare_flash_access(flashctx, true, false, false, false))
327 goto _free_ret;
328
329 msg_cinfo("Reading ich descriptor... ");
330 if (flashctx->chip->read(flashctx, desc, 0, 0x1000)) {
331 msg_cerr("Read operation failed!\n");
332 msg_cinfo("FAILED.\n");
333 ret = 2;
334 goto _finalize_ret;
335 }
336 msg_cinfo("done.\n");
337
338 if (layout_from_ich_descriptors(chip_layout, desc, 0x1000)) {
Patrick Rudolph911b8d82019-06-06 11:23:55 +0200339 msg_cerr("Couldn't parse the descriptor!\n");
Nico Huber305f4172013-06-14 11:55:26 +0200340 ret = 3;
341 goto _finalize_ret;
342 }
343
344 if (dump) {
345 if (layout_from_ich_descriptors(&dump_layout, dump, len)) {
Patrick Rudolph911b8d82019-06-06 11:23:55 +0200346 msg_cerr("Couldn't parse the descriptor!\n");
Nico Huber305f4172013-06-14 11:55:26 +0200347 ret = 4;
348 goto _finalize_ret;
349 }
350
351 if (chip_layout->base.num_entries != dump_layout.base.num_entries ||
352 memcmp(chip_layout->entries, dump_layout.entries, sizeof(dump_layout.entries))) {
Patrick Rudolph911b8d82019-06-06 11:23:55 +0200353 msg_cerr("Descriptors don't match!\n");
Nico Huber305f4172013-06-14 11:55:26 +0200354 ret = 5;
355 goto _finalize_ret;
356 }
357 }
358
359 *layout = (struct flashrom_layout *)chip_layout;
360 ret = 0;
361
362_finalize_ret:
363 finalize_flash_access(flashctx);
364_free_ret:
365 if (ret)
366 free(chip_layout);
367 free(desc);
368 return ret;
369#endif
370}
371
Nico Huberee13d0c2019-06-07 17:47:40 +0200372#ifdef __FLASHROM_LITTLE_ENDIAN__
Arthur Heymansc82900b2018-01-10 12:48:16 +0100373static int flashrom_layout_parse_fmap(struct flashrom_layout **layout,
374 struct flashctx *const flashctx, const struct fmap *const fmap)
375{
376 int i;
377 struct flashrom_layout *l = get_global_layout();
378
379 if (!fmap || !l)
380 return 1;
381
382 if (l->num_entries + fmap->nareas > MAX_ROMLAYOUT) {
383 msg_gerr("Cannot add fmap entries to layout - Too many entries.\n");
384 return 1;
385 }
386
387 for (i = 0; i < fmap->nareas; i++) {
388 l->entries[l->num_entries].start = fmap->areas[i].offset;
389 l->entries[l->num_entries].end = fmap->areas[i].offset + fmap->areas[i].size - 1;
390 l->entries[l->num_entries].included = false;
Nico Huber70461a92019-06-15 14:56:19 +0200391 l->entries[l->num_entries].name =
392 strndup((const char *)fmap->areas[i].name, FMAP_STRLEN);
393 if (!l->entries[l->num_entries].name) {
394 msg_gerr("Error adding layout entry: %s\n", strerror(errno));
395 return 1;
396 }
Arthur Heymansc82900b2018-01-10 12:48:16 +0100397 msg_gdbg("fmap %08x - %08x named %s\n",
398 l->entries[l->num_entries].start,
399 l->entries[l->num_entries].end,
400 l->entries[l->num_entries].name);
401 l->num_entries++;
402 }
403
404 *layout = l;
405 return 0;
406}
Nico Huberee13d0c2019-06-07 17:47:40 +0200407#endif /* __FLASHROM_LITTLE_ENDIAN__ */
Arthur Heymansc82900b2018-01-10 12:48:16 +0100408
409/**
410 * @brief Read a layout by searching the flash chip for fmap.
411 *
412 * @param[out] layout Points to a struct flashrom_layout pointer that
413 * gets set if the fmap is read and parsed successfully.
414 * @param[in] flashctx Flash context
415 * @param[in] offset Offset to begin searching for fmap.
416 * @param[in] offset Length of address space to search.
417 *
418 * @return 0 on success,
419 * 3 if fmap parsing isn't implemented for the host,
420 * 2 if the fmap couldn't be read,
421 * 1 on any other error.
422 */
423int flashrom_layout_read_fmap_from_rom(struct flashrom_layout **const layout,
424 struct flashctx *const flashctx, off_t offset, size_t len)
425{
426#ifndef __FLASHROM_LITTLE_ENDIAN__
427 return 3;
428#else
429 struct fmap *fmap = NULL;
430 int ret = 0;
431
432 msg_gdbg("Attempting to read fmap from ROM content.\n");
433 if (fmap_read_from_rom(&fmap, flashctx, offset, len)) {
434 msg_gerr("Failed to read fmap from ROM.\n");
435 return 1;
436 }
437
438 msg_gdbg("Adding fmap layout to global layout.\n");
439 if (flashrom_layout_parse_fmap(layout, flashctx, fmap)) {
440 msg_gerr("Failed to add fmap regions to layout.\n");
441 ret = 1;
442 }
443
444 free(fmap);
445 return ret;
446#endif
447}
448
449/**
450 * @brief Read a layout by searching buffer for fmap.
451 *
452 * @param[out] layout Points to a struct flashrom_layout pointer that
453 * gets set if the fmap is read and parsed successfully.
454 * @param[in] flashctx Flash context
455 * @param[in] buffer Buffer to search in
456 * @param[in] size Size of buffer to search
457 *
458 * @return 0 on success,
459 * 3 if fmap parsing isn't implemented for the host,
460 * 2 if the fmap couldn't be read,
461 * 1 on any other error.
462 */
463int flashrom_layout_read_fmap_from_buffer(struct flashrom_layout **const layout,
464 struct flashctx *const flashctx, const uint8_t *const buf, size_t size)
465{
466#ifndef __FLASHROM_LITTLE_ENDIAN__
467 return 3;
468#else
469 struct fmap *fmap = NULL;
470 int ret = 1;
471
472 if (!buf || !size)
473 goto _ret;
474
475 msg_gdbg("Attempting to read fmap from buffer.\n");
476 if (fmap_read_from_buffer(&fmap, buf, size)) {
477 msg_gerr("Failed to read fmap from buffer.\n");
478 goto _ret;
479 }
480
481 msg_gdbg("Adding fmap layout to global layout.\n");
482 if (flashrom_layout_parse_fmap(layout, flashctx, fmap)) {
483 msg_gerr("Failed to add fmap regions to layout.\n");
484 goto _free_ret;
485 }
486
487 ret = 0;
488_free_ret:
489 free(fmap);
490_ret:
491 return ret;
492#endif
493}
494
Nico Huber305f4172013-06-14 11:55:26 +0200495/**
Nico Huber454f6132012-12-10 13:34:10 +0000496 * @brief Set the active layout for a flash context.
497 *
498 * Note: This just sets a pointer. The caller must not release the layout
499 * as long as he uses it through the given flash context.
500 *
501 * @param flashctx Flash context whose layout will be set.
502 * @param layout Layout to bet set.
503 */
504void flashrom_layout_set(struct flashrom_flashctx *const flashctx, const struct flashrom_layout *const layout)
505{
506 flashctx->layout = layout;
507}
508
509/** @} */ /* end flashrom-layout */
Nikolai Artemievda1c8342021-10-21 00:58:12 +1100510
511
512/**
513 * @defgroup flashrom-wp
514 * @{
515 */
516
517/**
518 * @brief Create a new empty WP configuration.
519 *
520 * @param[out] cfg Points to a pointer of type struct flashrom_wp_cfg that will
521 * be set if creation succeeds. *cfg has to be freed by the
522 * caller with @ref flashrom_wp_cfg_release.
523 * @return 0 on success
524 * >0 on failure
525 */
526enum flashrom_wp_result flashrom_wp_cfg_new(struct flashrom_wp_cfg **cfg)
527{
528 *cfg = calloc(1, sizeof(**cfg));
529 return *cfg ? 0 : FLASHROM_WP_ERR_OTHER;
530}
531
532/**
533 * @brief Free a WP configuration.
534 *
535 * @param[out] cfg Pointer to the flashrom_wp_cfg to free.
536 */
537void flashrom_wp_cfg_release(struct flashrom_wp_cfg *cfg)
538{
539 free(cfg);
540}
541
542/**
543 * @brief Set the protection mode for a WP configuration.
544 *
545 * @param[in] mode The protection mode to set.
546 * @param[out] cfg Pointer to the flashrom_wp_cfg structure to modify.
547 */
548void flashrom_wp_set_mode(struct flashrom_wp_cfg *cfg, enum flashrom_wp_mode mode)
549{
550 cfg->mode = mode;
551}
552
553/**
554 * @brief Get the protection mode from a WP configuration.
555 *
556 * @param[in] cfg The WP configuration to get the protection mode from.
557 * @return The configuration's protection mode.
558 */
559enum flashrom_wp_mode flashrom_wp_get_mode(const struct flashrom_wp_cfg *cfg)
560{
561 return cfg->mode;
562}
563
564/**
565 * @brief Set the protection range for a WP configuration.
566 *
567 * @param[out] cfg Pointer to the flashrom_wp_cfg structure to modify.
568 * @param[in] start The range's start address.
569 * @param[in] len The range's length.
570 */
571void flashrom_wp_set_range(struct flashrom_wp_cfg *cfg, size_t start, size_t len)
572{
573 cfg->range.start = start;
574 cfg->range.len = len;
575}
576
577/**
578 * @brief Get the protection range from a WP configuration.
579 *
580 * @param[out] start Points to a size_t to write the range start to.
581 * @param[out] len Points to a size_t to write the range length to.
582 * @param[in] cfg The WP configuration to get the range from.
583 */
584void flashrom_wp_get_range(size_t *start, size_t *len, const struct flashrom_wp_cfg *cfg)
585{
586 *start = cfg->range.start;
587 *len = cfg->range.len;
588}
589
590/**
591 * @brief Write a WP configuration to a flash chip.
592 *
593 * @param[in] flash The flash context used to access the chip.
594 * @param[in] cfg The WP configuration to write to the chip.
595 * @return 0 on success
596 * >0 on failure
597 */
598enum flashrom_wp_result flashrom_wp_write_cfg(struct flashctx *flash, const struct flashrom_wp_cfg *cfg)
599{
600 /*
601 * TODO: Call custom implementation if the programmer is opaque, as
602 * direct WP operations require SPI access. In particular, linux_mtd
603 * has its own WP operations we should use instead.
604 */
605 if (flash->mst->buses_supported & BUS_SPI)
606 return wp_write_cfg(flash, cfg);
607
608 return FLASHROM_WP_ERR_OTHER;
609}
610
611/**
612 * @brief Read the current WP configuration from a flash chip.
613 *
614 * @param[out] cfg Pointer to a struct flashrom_wp_cfg to store the chip's
615 * configuration in.
616 * @param[in] flash The flash context used to access the chip.
617 * @return 0 on success
618 * >0 on failure
619 */
620enum flashrom_wp_result flashrom_wp_read_cfg(struct flashrom_wp_cfg *cfg, struct flashctx *flash)
621{
622 /*
623 * TODO: Call custom implementation if the programmer is opaque, as
624 * direct WP operations require SPI access. In particular, linux_mtd
625 * has its own WP operations we should use instead.
626 */
627 if (flash->mst->buses_supported & BUS_SPI)
628 return wp_read_cfg(cfg, flash);
629
630 return FLASHROM_WP_ERR_OTHER;
631}
632
Nikolai Artemiev077c0d12021-10-21 01:50:15 +1100633/**
634 * @brief Get a list of protection ranges supported by the flash chip.
635 *
636 * @param[out] ranges Points to a pointer of type struct flashrom_wp_ranges
637 * that will be set if available ranges are found. Finding
638 * available ranges may not always be possible, even if the
639 * chip's protection range can be read or modified. *ranges
640 * must be freed using @ref flashrom_wp_ranges_free.
641 * @param[in] flash The flash context used to access the chip.
642 * @return 0 on success
643 * >0 on failure
644 */
645enum flashrom_wp_result flashrom_wp_get_available_ranges(struct flashrom_wp_ranges **list, struct flashrom_flashctx *flash)
646{
647 /*
648 * TODO: Call custom implementation if the programmer is opaque, as
649 * direct WP operations require SPI access. We actually can't implement
650 * this in linux_mtd right now, but we should adopt a proper generic
651 * architechure to match the read and write functions anyway.
652 */
653 if (flash->mst->buses_supported & BUS_SPI)
654 return wp_get_available_ranges(list, flash);
655
656 return FLASHROM_WP_ERR_OTHER;
657}
658
659/**
660 * @brief Get a number of protection ranges in a range list.
661 *
662 * @param[in] ranges The range list to get the count from.
663 * @return Number of ranges in the list.
664 */
665size_t flashrom_wp_ranges_get_count(const struct flashrom_wp_ranges *list)
666{
667 return list->count;
668}
669
670/**
671 * @brief Get a protection range from a range list.
672 *
673 * @param[out] start Points to a size_t to write the range's start to.
674 * @param[out] len Points to a size_t to write the range's length to.
675 * @param[in] ranges The range list to get the range from.
676 * @param[in] index Index of the range to get.
677 * @return 0 on success
678 * >0 on failure
679 */
680enum flashrom_wp_result flashrom_wp_ranges_get_range(size_t *start, size_t *len, const struct flashrom_wp_ranges *list, unsigned int index)
681{
682 if (index >= list->count)
683 return FLASHROM_WP_ERR_OTHER;
684
685 *start = list->ranges[index].start;
686 *len = list->ranges[index].len;
687
688 return 0;
689}
690
691/**
692 * @brief Free a WP range list.
693 *
694 * @param[out] cfg Pointer to the flashrom_wp_ranges to free.
695 */
696void flashrom_wp_ranges_release(struct flashrom_wp_ranges *list)
697{
698 if (!list)
699 return;
700
701 free(list->ranges);
702 free(list);
703}
704
705
Nikolai Artemievda1c8342021-10-21 00:58:12 +1100706/** @} */ /* end flashrom-wp */