blob: 682abe3643dd0e9a9cf425566a241cad8c9a16ac [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 Huber5bd990c2019-06-16 19:46:46 +0200209 flashrom_layout_release(second_flashctx.default_layout);
Nico Huber38450ce2019-06-16 20:07:28 +0200210 free(second_flashctx.chip);
Nico Huber454f6132012-12-10 13:34:10 +0000211 ret = 3;
212 break;
213 }
214 }
215 }
216 if (ret) {
Nico Huber5bd990c2019-06-16 19:46:46 +0200217 flashrom_flash_release(*flashctx);
Nico Huber454f6132012-12-10 13:34:10 +0000218 *flashctx = NULL;
219 }
220 return ret;
221}
222
223/**
224 * @brief Returns the size of the specified flash chip in bytes.
225 *
226 * @param flashctx The queried flash context.
227 * @return Size of flash chip in bytes.
228 */
229size_t flashrom_flash_getsize(const struct flashrom_flashctx *const flashctx)
230{
231 return flashctx->chip->total_size * 1024;
232}
233
234/**
235 * @brief Free a flash context.
236 *
237 * @param flashctx Flash context to free.
238 */
239void flashrom_flash_release(struct flashrom_flashctx *const flashctx)
240{
Nico Huber6fb2f622022-02-24 18:17:40 +0100241 if (!flashctx)
242 return;
243
Nico Huber5bd990c2019-06-16 19:46:46 +0200244 flashrom_layout_release(flashctx->default_layout);
Nico Huber38450ce2019-06-16 20:07:28 +0200245 free(flashctx->chip);
Nico Huber454f6132012-12-10 13:34:10 +0000246 free(flashctx);
247}
248
249/**
250 * @brief Set a flag in the given flash context.
251 *
252 * @param flashctx Flash context to alter.
253 * @param flag Flag that is to be set / cleared.
254 * @param value Value to set.
255 */
256void flashrom_flag_set(struct flashrom_flashctx *const flashctx,
257 const enum flashrom_flag flag, const bool value)
258{
259 switch (flag) {
260 case FLASHROM_FLAG_FORCE: flashctx->flags.force = value; break;
261 case FLASHROM_FLAG_FORCE_BOARDMISMATCH: flashctx->flags.force_boardmismatch = value; break;
262 case FLASHROM_FLAG_VERIFY_AFTER_WRITE: flashctx->flags.verify_after_write = value; break;
263 case FLASHROM_FLAG_VERIFY_WHOLE_CHIP: flashctx->flags.verify_whole_chip = value; break;
264 }
265}
266
267/**
268 * @brief Return the current value of a flag in the given flash context.
269 *
270 * @param flashctx Flash context to read from.
271 * @param flag Flag to be read.
272 * @return Current value of the flag.
273 */
274bool flashrom_flag_get(const struct flashrom_flashctx *const flashctx, const enum flashrom_flag flag)
275{
276 switch (flag) {
277 case FLASHROM_FLAG_FORCE: return flashctx->flags.force;
278 case FLASHROM_FLAG_FORCE_BOARDMISMATCH: return flashctx->flags.force_boardmismatch;
279 case FLASHROM_FLAG_VERIFY_AFTER_WRITE: return flashctx->flags.verify_after_write;
280 case FLASHROM_FLAG_VERIFY_WHOLE_CHIP: return flashctx->flags.verify_whole_chip;
281 default: return false;
282 }
283}
284
285/** @} */ /* end flashrom-flash */
286
287
288
289/**
290 * @defgroup flashrom-layout Layout handling
291 * @{
292 */
293
294/**
Nico Huber305f4172013-06-14 11:55:26 +0200295 * @brief Read a layout from the Intel ICH descriptor in the flash.
296 *
297 * Optionally verify that the layout matches the one in the given
298 * descriptor dump.
299 *
300 * @param[out] layout Points to a struct flashrom_layout pointer that
301 * gets set if the descriptor is read and parsed
302 * successfully.
303 * @param[in] flashctx Flash context to read the descriptor from flash.
304 * @param[in] dump The descriptor dump to compare to or NULL.
305 * @param[in] len The length of the descriptor dump.
306 *
307 * @return 0 on success,
308 * 6 if descriptor parsing isn't implemented for the host,
309 * 5 if the descriptors don't match,
310 * 4 if the descriptor dump couldn't be parsed,
311 * 3 if the descriptor on flash couldn't be parsed,
312 * 2 if the descriptor on flash couldn't be read,
313 * 1 on any other error.
314 */
315int flashrom_layout_read_from_ifd(struct flashrom_layout **const layout, struct flashctx *const flashctx,
316 const void *const dump, const size_t len)
317{
318#ifndef __FLASHROM_LITTLE_ENDIAN__
319 return 6;
320#else
Nico Huber5bd990c2019-06-16 19:46:46 +0200321 struct flashrom_layout *dump_layout, *chip_layout;
Nico Huber305f4172013-06-14 11:55:26 +0200322 int ret = 1;
323
324 void *const desc = malloc(0x1000);
Nico Huber305f4172013-06-14 11:55:26 +0200325 if (prepare_flash_access(flashctx, true, false, false, false))
326 goto _free_ret;
327
328 msg_cinfo("Reading ich descriptor... ");
329 if (flashctx->chip->read(flashctx, desc, 0, 0x1000)) {
330 msg_cerr("Read operation failed!\n");
331 msg_cinfo("FAILED.\n");
332 ret = 2;
333 goto _finalize_ret;
334 }
335 msg_cinfo("done.\n");
336
Nico Huber5bd990c2019-06-16 19:46:46 +0200337 if (layout_from_ich_descriptors(&chip_layout, desc, 0x1000)) {
Patrick Rudolph911b8d82019-06-06 11:23:55 +0200338 msg_cerr("Couldn't parse the descriptor!\n");
Nico Huber305f4172013-06-14 11:55:26 +0200339 ret = 3;
340 goto _finalize_ret;
341 }
342
343 if (dump) {
344 if (layout_from_ich_descriptors(&dump_layout, dump, len)) {
Patrick Rudolph911b8d82019-06-06 11:23:55 +0200345 msg_cerr("Couldn't parse the descriptor!\n");
Nico Huber305f4172013-06-14 11:55:26 +0200346 ret = 4;
347 goto _finalize_ret;
348 }
349
Nico Huber5bd990c2019-06-16 19:46:46 +0200350 const struct romentry *chip_entry = layout_next(chip_layout, NULL);
351 const struct romentry *dump_entry = layout_next(dump_layout, NULL);
Nico Huber354766b2019-06-16 19:28:35 +0200352 while (chip_entry && dump_entry && !memcmp(chip_entry, dump_entry, sizeof(*chip_entry))) {
Nico Huber5bd990c2019-06-16 19:46:46 +0200353 chip_entry = layout_next(chip_layout, chip_entry);
354 dump_entry = layout_next(dump_layout, dump_entry);
Nico Huber354766b2019-06-16 19:28:35 +0200355 }
Nico Huber5bd990c2019-06-16 19:46:46 +0200356 flashrom_layout_release(dump_layout);
Nico Huber354766b2019-06-16 19:28:35 +0200357 if (chip_entry || dump_entry) {
Patrick Rudolph911b8d82019-06-06 11:23:55 +0200358 msg_cerr("Descriptors don't match!\n");
Nico Huber305f4172013-06-14 11:55:26 +0200359 ret = 5;
360 goto _finalize_ret;
361 }
362 }
363
364 *layout = (struct flashrom_layout *)chip_layout;
365 ret = 0;
366
367_finalize_ret:
368 finalize_flash_access(flashctx);
369_free_ret:
370 if (ret)
Nico Huber5bd990c2019-06-16 19:46:46 +0200371 flashrom_layout_release(chip_layout);
Nico Huber305f4172013-06-14 11:55:26 +0200372 free(desc);
373 return ret;
374#endif
375}
376
Nico Huberee13d0c2019-06-07 17:47:40 +0200377#ifdef __FLASHROM_LITTLE_ENDIAN__
Arthur Heymansc82900b2018-01-10 12:48:16 +0100378static int flashrom_layout_parse_fmap(struct flashrom_layout **layout,
379 struct flashctx *const flashctx, const struct fmap *const fmap)
380{
381 int i;
Nico Huber92e0b622019-06-15 15:55:11 +0200382 char name[FMAP_STRLEN + 1];
383 const struct fmap_area *area;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100384 struct flashrom_layout *l = get_global_layout();
385
386 if (!fmap || !l)
387 return 1;
388
Nico Huber92e0b622019-06-15 15:55:11 +0200389 for (i = 0, area = fmap->areas; i < fmap->nareas; i++, area++) {
390 snprintf(name, sizeof(name), "%s", area->name);
391 if (flashrom_layout_add_region(l, area->offset, area->offset + area->size - 1, name))
Nico Huber70461a92019-06-15 14:56:19 +0200392 return 1;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100393 }
394
395 *layout = l;
396 return 0;
397}
Nico Huberee13d0c2019-06-07 17:47:40 +0200398#endif /* __FLASHROM_LITTLE_ENDIAN__ */
Arthur Heymansc82900b2018-01-10 12:48:16 +0100399
400/**
401 * @brief Read a layout by searching the flash chip for fmap.
402 *
403 * @param[out] layout Points to a struct flashrom_layout pointer that
404 * gets set if the fmap is read and parsed successfully.
405 * @param[in] flashctx Flash context
406 * @param[in] offset Offset to begin searching for fmap.
407 * @param[in] offset Length of address space to search.
408 *
409 * @return 0 on success,
410 * 3 if fmap parsing isn't implemented for the host,
411 * 2 if the fmap couldn't be read,
412 * 1 on any other error.
413 */
414int flashrom_layout_read_fmap_from_rom(struct flashrom_layout **const layout,
Julius Werner8f0db7d2022-02-14 17:07:39 -0800415 struct flashctx *const flashctx, size_t offset, size_t len)
Arthur Heymansc82900b2018-01-10 12:48:16 +0100416{
417#ifndef __FLASHROM_LITTLE_ENDIAN__
418 return 3;
419#else
420 struct fmap *fmap = NULL;
421 int ret = 0;
422
423 msg_gdbg("Attempting to read fmap from ROM content.\n");
424 if (fmap_read_from_rom(&fmap, flashctx, offset, len)) {
425 msg_gerr("Failed to read fmap from ROM.\n");
426 return 1;
427 }
428
429 msg_gdbg("Adding fmap layout to global layout.\n");
430 if (flashrom_layout_parse_fmap(layout, flashctx, fmap)) {
431 msg_gerr("Failed to add fmap regions to layout.\n");
432 ret = 1;
433 }
434
435 free(fmap);
436 return ret;
437#endif
438}
439
440/**
441 * @brief Read a layout by searching buffer for fmap.
442 *
443 * @param[out] layout Points to a struct flashrom_layout pointer that
444 * gets set if the fmap is read and parsed successfully.
445 * @param[in] flashctx Flash context
446 * @param[in] buffer Buffer to search in
447 * @param[in] size Size of buffer to search
448 *
449 * @return 0 on success,
450 * 3 if fmap parsing isn't implemented for the host,
451 * 2 if the fmap couldn't be read,
452 * 1 on any other error.
453 */
454int flashrom_layout_read_fmap_from_buffer(struct flashrom_layout **const layout,
455 struct flashctx *const flashctx, const uint8_t *const buf, size_t size)
456{
457#ifndef __FLASHROM_LITTLE_ENDIAN__
458 return 3;
459#else
460 struct fmap *fmap = NULL;
461 int ret = 1;
462
463 if (!buf || !size)
464 goto _ret;
465
466 msg_gdbg("Attempting to read fmap from buffer.\n");
467 if (fmap_read_from_buffer(&fmap, buf, size)) {
468 msg_gerr("Failed to read fmap from buffer.\n");
469 goto _ret;
470 }
471
472 msg_gdbg("Adding fmap layout to global layout.\n");
473 if (flashrom_layout_parse_fmap(layout, flashctx, fmap)) {
474 msg_gerr("Failed to add fmap regions to layout.\n");
475 goto _free_ret;
476 }
477
478 ret = 0;
479_free_ret:
480 free(fmap);
481_ret:
482 return ret;
483#endif
484}
485
Nico Huber305f4172013-06-14 11:55:26 +0200486/**
Nico Huber454f6132012-12-10 13:34:10 +0000487 * @brief Set the active layout for a flash context.
488 *
489 * Note: This just sets a pointer. The caller must not release the layout
490 * as long as he uses it through the given flash context.
491 *
492 * @param flashctx Flash context whose layout will be set.
493 * @param layout Layout to bet set.
494 */
495void flashrom_layout_set(struct flashrom_flashctx *const flashctx, const struct flashrom_layout *const layout)
496{
497 flashctx->layout = layout;
498}
499
500/** @} */ /* end flashrom-layout */
Nikolai Artemievda1c8342021-10-21 00:58:12 +1100501
502
503/**
504 * @defgroup flashrom-wp
505 * @{
506 */
507
508/**
509 * @brief Create a new empty WP configuration.
510 *
511 * @param[out] cfg Points to a pointer of type struct flashrom_wp_cfg that will
512 * be set if creation succeeds. *cfg has to be freed by the
513 * caller with @ref flashrom_wp_cfg_release.
514 * @return 0 on success
515 * >0 on failure
516 */
517enum flashrom_wp_result flashrom_wp_cfg_new(struct flashrom_wp_cfg **cfg)
518{
519 *cfg = calloc(1, sizeof(**cfg));
520 return *cfg ? 0 : FLASHROM_WP_ERR_OTHER;
521}
522
523/**
524 * @brief Free a WP configuration.
525 *
526 * @param[out] cfg Pointer to the flashrom_wp_cfg to free.
527 */
528void flashrom_wp_cfg_release(struct flashrom_wp_cfg *cfg)
529{
530 free(cfg);
531}
532
533/**
534 * @brief Set the protection mode for a WP configuration.
535 *
536 * @param[in] mode The protection mode to set.
537 * @param[out] cfg Pointer to the flashrom_wp_cfg structure to modify.
538 */
539void flashrom_wp_set_mode(struct flashrom_wp_cfg *cfg, enum flashrom_wp_mode mode)
540{
541 cfg->mode = mode;
542}
543
544/**
545 * @brief Get the protection mode from a WP configuration.
546 *
547 * @param[in] cfg The WP configuration to get the protection mode from.
548 * @return The configuration's protection mode.
549 */
550enum flashrom_wp_mode flashrom_wp_get_mode(const struct flashrom_wp_cfg *cfg)
551{
552 return cfg->mode;
553}
554
555/**
556 * @brief Set the protection range for a WP configuration.
557 *
558 * @param[out] cfg Pointer to the flashrom_wp_cfg structure to modify.
559 * @param[in] start The range's start address.
560 * @param[in] len The range's length.
561 */
562void flashrom_wp_set_range(struct flashrom_wp_cfg *cfg, size_t start, size_t len)
563{
564 cfg->range.start = start;
565 cfg->range.len = len;
566}
567
568/**
569 * @brief Get the protection range from a WP configuration.
570 *
571 * @param[out] start Points to a size_t to write the range start to.
572 * @param[out] len Points to a size_t to write the range length to.
573 * @param[in] cfg The WP configuration to get the range from.
574 */
575void flashrom_wp_get_range(size_t *start, size_t *len, const struct flashrom_wp_cfg *cfg)
576{
577 *start = cfg->range.start;
578 *len = cfg->range.len;
579}
580
581/**
582 * @brief Write a WP configuration to a flash chip.
583 *
584 * @param[in] flash The flash context used to access the chip.
585 * @param[in] cfg The WP configuration to write to the chip.
586 * @return 0 on success
587 * >0 on failure
588 */
589enum flashrom_wp_result flashrom_wp_write_cfg(struct flashctx *flash, const struct flashrom_wp_cfg *cfg)
590{
591 /*
592 * TODO: Call custom implementation if the programmer is opaque, as
593 * direct WP operations require SPI access. In particular, linux_mtd
594 * has its own WP operations we should use instead.
595 */
596 if (flash->mst->buses_supported & BUS_SPI)
597 return wp_write_cfg(flash, cfg);
598
599 return FLASHROM_WP_ERR_OTHER;
600}
601
602/**
603 * @brief Read the current WP configuration from a flash chip.
604 *
605 * @param[out] cfg Pointer to a struct flashrom_wp_cfg to store the chip's
606 * configuration in.
607 * @param[in] flash The flash context used to access the chip.
608 * @return 0 on success
609 * >0 on failure
610 */
611enum flashrom_wp_result flashrom_wp_read_cfg(struct flashrom_wp_cfg *cfg, struct flashctx *flash)
612{
613 /*
614 * TODO: Call custom implementation if the programmer is opaque, as
615 * direct WP operations require SPI access. In particular, linux_mtd
616 * has its own WP operations we should use instead.
617 */
618 if (flash->mst->buses_supported & BUS_SPI)
619 return wp_read_cfg(cfg, flash);
620
621 return FLASHROM_WP_ERR_OTHER;
622}
623
Nikolai Artemiev077c0d12021-10-21 01:50:15 +1100624/**
625 * @brief Get a list of protection ranges supported by the flash chip.
626 *
627 * @param[out] ranges Points to a pointer of type struct flashrom_wp_ranges
628 * that will be set if available ranges are found. Finding
629 * available ranges may not always be possible, even if the
630 * chip's protection range can be read or modified. *ranges
631 * must be freed using @ref flashrom_wp_ranges_free.
632 * @param[in] flash The flash context used to access the chip.
633 * @return 0 on success
634 * >0 on failure
635 */
636enum flashrom_wp_result flashrom_wp_get_available_ranges(struct flashrom_wp_ranges **list, struct flashrom_flashctx *flash)
637{
638 /*
639 * TODO: Call custom implementation if the programmer is opaque, as
640 * direct WP operations require SPI access. We actually can't implement
641 * this in linux_mtd right now, but we should adopt a proper generic
642 * architechure to match the read and write functions anyway.
643 */
644 if (flash->mst->buses_supported & BUS_SPI)
645 return wp_get_available_ranges(list, flash);
646
647 return FLASHROM_WP_ERR_OTHER;
648}
649
650/**
651 * @brief Get a number of protection ranges in a range list.
652 *
653 * @param[in] ranges The range list to get the count from.
654 * @return Number of ranges in the list.
655 */
656size_t flashrom_wp_ranges_get_count(const struct flashrom_wp_ranges *list)
657{
658 return list->count;
659}
660
661/**
662 * @brief Get a protection range from a range list.
663 *
664 * @param[out] start Points to a size_t to write the range's start to.
665 * @param[out] len Points to a size_t to write the range's length to.
666 * @param[in] ranges The range list to get the range from.
667 * @param[in] index Index of the range to get.
668 * @return 0 on success
669 * >0 on failure
670 */
671enum flashrom_wp_result flashrom_wp_ranges_get_range(size_t *start, size_t *len, const struct flashrom_wp_ranges *list, unsigned int index)
672{
673 if (index >= list->count)
674 return FLASHROM_WP_ERR_OTHER;
675
676 *start = list->ranges[index].start;
677 *len = list->ranges[index].len;
678
679 return 0;
680}
681
682/**
683 * @brief Free a WP range list.
684 *
685 * @param[out] cfg Pointer to the flashrom_wp_ranges to free.
686 */
687void flashrom_wp_ranges_release(struct flashrom_wp_ranges *list)
688{
689 if (!list)
690 return;
691
692 free(list->ranges);
693 free(list);
694}
695
696
Nikolai Artemievda1c8342021-10-21 00:58:12 +1100697/** @} */ /* end flashrom-wp */