/* this header file contains definitions for fc-loadtool flash support */

/* global configuration */
#define	FLASH_GLOBAL_CFG_NONE		0
#define	FLASH_GLOBAL_CFG_SINGLE_4M	1
#define	FLASH_GLOBAL_CFG_SINGLE_8M	2
#define	FLASH_GLOBAL_CFG_DUAL_8M	3

/*
 * The following structures represent an "abstract"
 * description of flash devices.
 *
 * A "region" is a consecutive group of erase units of the same size.
 */

struct flash_region_desc {
	uint32_t	sector_size;
	unsigned	nsectors;
};

#define	CFI_MAX_REGIONS		4

/*
 * The info in struct flash_geom can be either
 * gathered from CFI or hard-coded.
 */
struct flash_geom {
	uint32_t			total_size;
	unsigned			nregions;
	struct flash_region_desc	regions[CFI_MAX_REGIONS];
	unsigned			total_sectors;
};

struct cfi_check {
	int	offset;
	uint8_t	expect_val;
};

/*
 * In order to examine non-volatile sector lock state of AMD-style flash
 * chips, we need to know how their sectors are grouped for the purpose
 * of locking: aggregation of sectors into groups that can only be locked
 * or unlocked as a unit, and also grouping into independent-read partitions
 * where each partition needs its own Autoselect sequence.
 */

struct lock_group_desc {
	uint32_t	block_size;
	unsigned	nblocks;
	int		is_group;
	int		part_begin;
	int		part_end;
};

#define	MAX_AMD_LOCK_GROUPS	8

struct amd_lock_info {
	unsigned		ngroups;
	struct lock_group_desc	groups[MAX_AMD_LOCK_GROUPS];
	int			have_status_word_3;
	int			have_status_word_7;
	int			have_mode_lock_bits;
	int			have_pln_lock_reg;
	int			(*ppb_program_one)();
	int			(*ppb_program_all)();
	int			(*ppb_erase_all)();
};

struct flash_device {
	char			*name;
	struct cfi_check	*cfi_table;
	int			required_global_config;
	struct flash_geom	*bank_geom[2];
	struct flash_cmdset	*cmdset;
	struct amd_lock_info	*lock_info[2];
};

/* the following structures describe flash banks as accessible to us */

struct sector_info {
	uint32_t	start;
	uint32_t	size;
};

struct flash_cmdset {
	char	*cmdset_name;
	int	(*reset_cmd)();
	int	(*status_cmd)();
	int	(*unlock_sector)();
	int	(*erase_sector)();
	int	(*prep_for_program)();
	int	(*read_prot_reg)();
	char	*loadagent_setbase_cmd;
	char	*loadagent_program_cmd;
	char	*loadagent_binmode_cmd;
	int	needs_unlock;
};

struct flash_bank_info {
	uint32_t		base_addr;
	struct flash_device	*device;
	struct flash_geom	*geom;
	struct flash_cmdset	*ops;
	struct amd_lock_info	*amd_lock;
	struct sector_info	*sectors;
	int			detect_done;
};