Layout handling

Functions
int	flashrom_layout_new (struct flashrom_layout **layout)
	Create a new, empty layout. More...
int	flashrom_layout_read_from_ifd (struct flashrom_layout **layout, struct flashrom_flashctx *flashctx, const void *dump, size_t len)
	Read a layout from the Intel ICH descriptor in the flash. More...
int	flashrom_layout_read_fmap_from_rom (struct flashrom_layout **layout, struct flashrom_flashctx *flashctx, size_t offset, size_t length)
	Read a layout by searching the flash chip for fmap. More...
int	flashrom_layout_read_fmap_from_buffer (struct flashrom_layout **layout, struct flashrom_flashctx *flashctx, const uint8_t *buffer, size_t len)
	Read a layout by searching a buffer for fmap. More...
int	flashrom_layout_add_region (struct flashrom_layout *layout, size_t start, size_t end, const char *name)
	Add a region to an existing layout. More...
int	flashrom_layout_include_region (struct flashrom_layout *layout, const char *name)
	Mark given region as included. More...
int	flashrom_layout_exclude_region (struct flashrom_layout *layout, const char *name)
	Mark given region as not included. More...
int	flashrom_layout_get_region_range (struct flashrom_layout *layout, const char *name, unsigned int *start, unsigned int *len)
	Get given region's offset and length. More...
void	flashrom_layout_release (struct flashrom_layout *layout)
	Free a layout. More...
int	flashrom_layout_compare (const struct flashrom_layout *layout1, const struct flashrom_layout *layout2)
	Compare two flashrom layouts for equality. More...
void	flashrom_layout_set (struct flashrom_flashctx *flashctx, const struct flashrom_layout *layout)
	Set the active layout for a flash context. More...

Detailed Description

Function Documentation

int flashrom_layout_add_region	(	struct flashrom_layout *	layout,
		size_t	start,
		size_t	end,
		const char *	name
	)

Add a region to an existing layout.

Parameters

layout	The existing layout.
start	Start address of the region.
end	End address (inclusive) of the region.
name	Name of the region.

Returns

0 on success, 1 if out of memory.

int flashrom_layout_compare	(	const struct flashrom_layout *	layout1,
		const struct flashrom_layout *	layout2
	)

Compare two flashrom layouts for equality.

Compares all regions in both layouts. Two layouts are considered equal if they contain the same number of regions, in the same order, with identical start/end addresses and names.

Parameters

layout1	First layout to compare.
layout2	Second layout to compare.

Returns

0 if layouts are identical, 1 if they differ or if either layout is NULL.

int flashrom_layout_exclude_region	(	struct flashrom_layout *	layout,
		const char *	name
	)

Mark given region as not included.

Parameters

layout	The layout to alter.
name	The name of the region to exclude.

Returns

0 on success, 1 if the given name can't be found.

int flashrom_layout_get_region_range	(	struct flashrom_layout *	layout,
		const char *	name,
		unsigned int *	start,
		unsigned int *	len
	)

Get given region's offset and length.

Parameters

[in]	layout	The existing layout.
[in]	name	The name of the region.
[out]	start	The start address to be written.
[out]	len	The length of the region to be written.

Returns

0 on success, 1 if the given name can't be found.

int flashrom_layout_include_region	(	struct flashrom_layout *	layout,
		const char *	name
	)

Mark given region as included.

Parameters

layout	The layout to alter.
name	The name of the region to include.

Returns

0 on success, 1 if the given name can't be found.

int flashrom_layout_new

(

struct flashrom_layout **

layout

)

Create a new, empty layout.

Parameters

layout

Pointer to returned layout reference.

Returns

0 on success, 1 if out of memory.

int flashrom_layout_read_fmap_from_buffer	(	struct flashrom_layout **	layout,
		struct flashrom_flashctx *	flashctx,
		const uint8_t *	buffer,
		size_t	len
	)

Read a layout by searching a buffer for fmap.

Parameters

[out]	layout	Points to a struct flashrom_layout pointer that gets set if the fmap is read and parsed successfully.
[in]	flashctx	Flash context
[in]	buffer	Buffer to search in
[in]	len	Size of buffer to search

Returns

0 on success, 3 if fmap parsing isn't implemented for the host, 2 if the fmap couldn't be read, 1 on any other error.

int flashrom_layout_read_fmap_from_rom	(	struct flashrom_layout **	layout,
		struct flashrom_flashctx *	flashctx,
		size_t	offset,
		size_t	length
	)

Read a layout by searching the flash chip for fmap.

Parameters

[out]	layout	Points to a struct flashrom_layout pointer that gets set if the fmap is read and parsed successfully.
[in]	flashctx	Flash context
[in]	offset	Offset to begin searching for fmap.
[in]	length	Length of address space to search.

Returns

0 on success, 3 if fmap parsing isn't implemented for the host, 2 if the fmap couldn't be read, 1 on any other error.

int flashrom_layout_read_from_ifd	(	struct flashrom_layout **	layout,
		struct flashrom_flashctx *	flashctx,
		const void *	dump,
		size_t	len
	)

Read a layout from the Intel ICH descriptor in the flash.

Optionally verify that the layout matches the one in the given descriptor dump.

Parameters

[out]	layout	Points to a struct flashrom_layout pointer that gets set if the descriptor is read and parsed successfully.
[in]	flashctx	Flash context to read the descriptor from flash.
[in]	dump	The descriptor dump to compare to or NULL.
[in]	len	The length of the descriptor dump.

Returns

0 on success, 6 if descriptor parsing isn't implemented for the host, 5 if the descriptors don't match, 4 if the descriptor dump couldn't be parsed, 3 if the descriptor on flash couldn't be parsed, 2 if the descriptor on flash couldn't be read, 1 on any other error.

void flashrom_layout_release

(

struct flashrom_layout *

layout

)

Free a layout.

Parameters

layout

Layout to free.

void flashrom_layout_set	(	struct flashrom_flashctx *	flashctx,
		const struct flashrom_layout *	layout
	)

Set the active layout for a flash context.

Note: The caller must not release the layout as long as it is used through the given flash context.

Parameters

flashctx	Flash context whose layout will be set.
layout	Layout to bet set.