aboutsummaryrefslogtreecommitdiffstats
path: root/libflashrom.h
blob: d3f3dedcf0ac963e628c3e12a79fe441830879dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*
 * This file is part of the flashrom project.
 *
 * Copyright (C) 2012 secunet Security Networks AG
 * (Written by Nico Huber <nico.huber@secunet.com> for secunet)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef __LIBFLASHROM_H__
#define __LIBFLASHROM_H__ 1

#include <stdarg.h>

int flashrom_init(int perform_selfcheck);
int flashrom_shutdown(void);
/** @ingroup flashrom-general */
enum flashrom_log_level {
	FLASHROM_MSG_ERROR	= 0,
	FLASHROM_MSG_WARN	= 1,
	FLASHROM_MSG_INFO	= 2,
	FLASHROM_MSG_DEBUG	= 3,
	FLASHROM_MSG_DEBUG2	= 4,
	FLASHROM_MSG_SPEW	= 5,
};
/** @ingroup flashrom-general */
typedef int(flashrom_log_callback)(enum flashrom_log_level, const char *format, va_list);
void flashrom_set_log_callback(flashrom_log_callback *);

struct flashrom_programmer;
int flashrom_programmer_init(struct flashrom_programmer **, const char *prog_name, const char *prog_params);
int flashrom_programmer_shutdown(struct flashrom_programmer *);

struct flashrom_flashctx;
int flashrom_flash_probe(struct flashrom_flashctx **, const struct flashrom_programmer *, const char *chip_name);
size_t flashrom_flash_getsize(const struct flashrom_flashctx *);
int flashrom_flash_erase(struct flashrom_flashctx *);
void flashrom_flash_release(struct flashrom_flashctx *);

/** @ingroup flashrom-flash */
enum flashrom_flag {
	FLASHROM_FLAG_FORCE,
	FLASHROM_FLAG_FORCE_BOARDMISMATCH,
	FLASHROM_FLAG_VERIFY_AFTER_WRITE,
	FLASHROM_FLAG_VERIFY_WHOLE_CHIP,
};
void flashrom_flag_set(struct flashrom_flashctx *, enum flashrom_flag, bool value);
bool flashrom_flag_get(const struct flashrom_flashctx *, enum flashrom_flag);

int flashrom_image_read(struct flashrom_flashctx *, void *buffer, size_t buffer_len);
int flashrom_image_write(struct flashrom_flashctx *, void *buffer, size_t buffer_len);
int flashrom_image_verify(struct flashrom_flashctx *, const void *buffer, size_t buffer_len);

struct flashrom_layout;
int flashrom_layout_read_from_ifd(struct flashrom_layout **, struct flashrom_flashctx *, const void *dump, size_t len);
int flashrom_layout_include_region(struct flashrom_layout *, const char *name);
void flashrom_layout_release(struct flashrom_layout *);
void flashrom_layout_set(struct flashrom_flashctx *, const struct flashrom_layout *);

#endif				/* !__LIBFLASHROM_H__ */
the version. function Library_To_File_Name (Library: Iir_Library_Declaration) return String; -- Set the name of the work library, load the work library. -- Note: the scanner shouldn't be in use, since this function uses it. -- If EMPTY is set, the work library is just created and not loaded. procedure Load_Work_Library (Empty : Boolean := False); -- Initialize the library manager and load the STD library. -- If BUILD_STANDARD is false, the std.standard library is not created. -- Return TRUE in case of success, FALSE in case of failure. function Load_Std_Library (Build_Standard : Boolean := True) return Boolean; -- Save the work library as a host-dependent library. procedure Save_Work_Library; -- Remove the same file as DESIGN_FILE from work library and all of its -- units. procedure Purge_Design_File (Design_File : Iir_Design_File); -- Just return the design_unit for NAME, or NULL if not found. function Find_Primary_Unit (Library: Iir_Library_Declaration; Name: Name_Id) return Iir_Design_Unit; -- Get the library named IDENT. Return Null_Iir if it doesn't exist. function Get_Library_No_Create (Ident : Name_Id) return Iir_Library_Declaration; -- Get or create a library from an identifier. -- LOC is used only to report errors. function Get_Library (Ident : Name_Id; Loc : Location_Type) return Iir_Library_Declaration; -- Add or replace an design unit in the work library. -- DECL must not have a chain (because it may be modified). -- -- If the design_file of UNIT is not already in the library, a new one -- is created. -- -- Units are always appended to the design_file. Therefore, the order is -- kept. -- -- If KEEP_OBSOLETE is True, obsoleted units are kept in the library. -- This is used when a whole design file has to be added in the library and -- then processed (without that feature, redefined units would disappear). procedure Add_Design_Unit_Into_Library (Unit : in Iir_Design_Unit; Keep_Obsolete : Boolean := False); -- Put all design_units of FILE into the work library, by calling -- Add_Design_Unit_Into_Library. -- FILE is updated since it may changed (FILE is never put in the library, -- a new one is created). procedure Add_Design_File_Into_Library (File : in out Iir_Design_File); -- Return the latest architecture analysed for entity ENTITY. function Get_Latest_Architecture (Entity: Iir_Entity_Declaration) return Iir_Architecture_Body; -- Return the design unit (stubed if not loaded) from UNIT. -- UNIT may be either a design unit, in this case UNIT is returned, -- or a selected name, in this case the prefix is a library name and -- the suffix a primary design unit name, -- or an entity_aspect_entity to designate an architectrure. -- Return null_iir if the design unit is not found. function Find_Design_Unit (Unit : Iir) return Iir_Design_Unit; -- Find the secondary unit of PRIMARY. -- If PRIMARY is a package declaration, returns the package body, -- If PRIMARY is an entity declaration, returns the architecture NAME. -- Return NULL_IIR if not found. function Find_Secondary_Unit (Primary: Iir_Design_Unit; Name: Name_Id) return Iir_Design_Unit; -- Search design file NAME in library LIB. This is not very efficient as -- this is a simple linear search. NAME must correspond exactely to the -- design file name. function Find_Design_File (Lib : Iir_Library_Declaration; Name : Name_Id) return Iir; -- Find an entity whose name is NAME in any library. -- If there is no such entity, return NULL_IIR. -- If there are several entities, return NULL_IIR; function Find_Entity_For_Component (Name: Name_Id) return Iir_Design_Unit; -- Decode '--work=NAME' command line option and return the identifier -- for the library. -- To effectively use the library, assign Work_Library_Name and load the -- library by calling Load_Work_Library. -- Return Null_Identifier if NAME is not a valid name. function Decode_Work_Option (Opt : String) return Name_Id; -- Get the chain of libraries. Can be used only to read (it mustn't be -- modified). function Get_Libraries_Chain return Iir_Library_Declaration; end Libraries;