[people/ms/u-boot.git] / include / part.h

/*
 * (C) Copyright 2000-2004
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */
#ifndef _PART_H
#define _PART_H

#include <ide.h>

typedef struct block_dev_desc {
	int		if_type;	/* type of the interface */
	int		dev;		/* device number */
	unsigned char	part_type;	/* partition type */
	unsigned char	target;		/* target SCSI ID */
	unsigned char	lun;		/* target LUN */
	unsigned char	type;		/* device type */
	unsigned char	removable;	/* removable device */
#ifdef CONFIG_LBA48
	unsigned char	lba48;		/* device can use 48bit addr (ATA/ATAPI v7) */
#endif
	lbaint_t	lba;		/* number of blocks */
	unsigned long	blksz;		/* block size */
	int		log2blksz;	/* for convenience: log2(blksz) */
	char		vendor [40+1];	/* IDE model, SCSI Vendor */
	char		product[20+1];	/* IDE Serial no, SCSI product */
	char		revision[8+1];	/* firmware revision */
	unsigned long	(*block_read)(int dev,
				      lbaint_t start,
				      lbaint_t blkcnt,
				      void *buffer);
	unsigned long	(*block_write)(int dev,
				       lbaint_t start,
				       lbaint_t blkcnt,
				       const void *buffer);
	unsigned long   (*block_erase)(int dev,
				       lbaint_t start,
				       lbaint_t blkcnt);
	void		*priv;		/* driver private struct pointer */
}block_dev_desc_t;

#define BLOCK_CNT(size, block_dev_desc) (PAD_COUNT(size, block_dev_desc->blksz))
#define PAD_TO_BLOCKSIZE(size, block_dev_desc) \
	(PAD_SIZE(size, block_dev_desc->blksz))
#define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
		 ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
		 ((x & 0xffff0000) ? 16 : 0))
#define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))

/* Interface types: */
#define IF_TYPE_UNKNOWN		0
#define IF_TYPE_IDE		1
#define IF_TYPE_SCSI		2
#define IF_TYPE_ATAPI		3
#define IF_TYPE_USB		4
#define IF_TYPE_DOC		5
#define IF_TYPE_MMC		6
#define IF_TYPE_SD		7
#define IF_TYPE_SATA		8
#define IF_TYPE_HOST		9
#define IF_TYPE_MAX		10	/* Max number of IF_TYPE_* supported */

/* Part types */
#define PART_TYPE_UNKNOWN	0x00
#define PART_TYPE_MAC		0x01
#define PART_TYPE_DOS		0x02
#define PART_TYPE_ISO		0x03
#define PART_TYPE_AMIGA		0x04
#define PART_TYPE_EFI		0x05

/*
 * Type string for U-Boot bootable partitions
 */
#define BOOT_PART_TYPE	"U-Boot"	/* primary boot partition type	*/
#define BOOT_PART_COMP	"PPCBoot"	/* PPCBoot compatibility type	*/

/* device types */
#define DEV_TYPE_UNKNOWN	0xff	/* not connected */
#define DEV_TYPE_HARDDISK	0x00	/* harddisk */
#define DEV_TYPE_TAPE		0x01	/* Tape */
#define DEV_TYPE_CDROM		0x05	/* CD-ROM */
#define DEV_TYPE_OPDISK		0x07	/* optical disk */

typedef struct disk_partition {
	lbaint_t	start;	/* # of first block in partition	*/
	lbaint_t	size;	/* number of blocks in partition	*/
	ulong	blksz;		/* block size in bytes			*/
	uchar	name[32];	/* partition name			*/
	uchar	type[32];	/* string type description		*/
	int	bootable;	/* Active/Bootable flag is set		*/
#ifdef CONFIG_PARTITION_UUIDS
	char	uuid[37];	/* filesystem UUID as string, if exists	*/
#endif
} disk_partition_t;

/* Misc _get_dev functions */
#ifdef CONFIG_PARTITIONS
block_dev_desc_t *get_dev(const char *ifname, int dev);
block_dev_desc_t* ide_get_dev(int dev);
block_dev_desc_t* sata_get_dev(int dev);
block_dev_desc_t* scsi_get_dev(int dev);
block_dev_desc_t* usb_stor_get_dev(int dev);
block_dev_desc_t* mmc_get_dev(int dev);
block_dev_desc_t* systemace_get_dev(int dev);
block_dev_desc_t* mg_disk_get_dev(int dev);
block_dev_desc_t *host_get_dev(int dev);
int host_get_dev_err(int dev, block_dev_desc_t **blk_devp);

/* disk/part.c */
int get_partition_info (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
void print_part (block_dev_desc_t *dev_desc);
void  init_part (block_dev_desc_t *dev_desc);
void dev_print(block_dev_desc_t *dev_desc);
int get_device(const char *ifname, const char *dev_str,
	       block_dev_desc_t **dev_desc);
int get_device_and_partition(const char *ifname, const char *dev_part_str,
			     block_dev_desc_t **dev_desc,
			     disk_partition_t *info, int allow_whole_dev);
#else
static inline block_dev_desc_t *get_dev(const char *ifname, int dev)
{ return NULL; }
static inline block_dev_desc_t* ide_get_dev(int dev) { return NULL; }
static inline block_dev_desc_t* sata_get_dev(int dev) { return NULL; }
static inline block_dev_desc_t* scsi_get_dev(int dev) { return NULL; }
static inline block_dev_desc_t* usb_stor_get_dev(int dev) { return NULL; }
static inline block_dev_desc_t* mmc_get_dev(int dev) { return NULL; }
static inline block_dev_desc_t* systemace_get_dev(int dev) { return NULL; }
static inline block_dev_desc_t* mg_disk_get_dev(int dev) { return NULL; }
static inline block_dev_desc_t *host_get_dev(int dev) { return NULL; }

static inline int get_partition_info (block_dev_desc_t * dev_desc, int part,
	disk_partition_t *info) { return -1; }
static inline void print_part (block_dev_desc_t *dev_desc) {}
static inline void  init_part (block_dev_desc_t *dev_desc) {}
static inline void dev_print(block_dev_desc_t *dev_desc) {}
static inline int get_device(const char *ifname, const char *dev_str,
	       block_dev_desc_t **dev_desc)
{ return -1; }
static inline int get_device_and_partition(const char *ifname,
					   const char *dev_part_str,
					   block_dev_desc_t **dev_desc,
					   disk_partition_t *info,
					   int allow_whole_dev)
{ *dev_desc = NULL; return -1; }
#endif

#ifdef CONFIG_MAC_PARTITION
/* disk/part_mac.c */
int get_partition_info_mac (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
void print_part_mac (block_dev_desc_t *dev_desc);
int   test_part_mac (block_dev_desc_t *dev_desc);
#endif

#ifdef CONFIG_DOS_PARTITION
/* disk/part_dos.c */
int get_partition_info_dos (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
void print_part_dos (block_dev_desc_t *dev_desc);
int   test_part_dos (block_dev_desc_t *dev_desc);
#endif

#ifdef CONFIG_ISO_PARTITION
/* disk/part_iso.c */
int get_partition_info_iso (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
void print_part_iso (block_dev_desc_t *dev_desc);
int   test_part_iso (block_dev_desc_t *dev_desc);
#endif

#ifdef CONFIG_AMIGA_PARTITION
/* disk/part_amiga.c */
int get_partition_info_amiga (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
void print_part_amiga (block_dev_desc_t *dev_desc);
int   test_part_amiga (block_dev_desc_t *dev_desc);
#endif

#ifdef CONFIG_EFI_PARTITION
#include <part_efi.h>
/* disk/part_efi.c */
int get_partition_info_efi (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
void print_part_efi (block_dev_desc_t *dev_desc);
int   test_part_efi (block_dev_desc_t *dev_desc);

/**
 * write_gpt_table() - Write the GUID Partition Table to disk
 *
 * @param dev_desc - block device descriptor
 * @param gpt_h - pointer to GPT header representation
 * @param gpt_e - pointer to GPT partition table entries
 *
 * @return - zero on success, otherwise error
 */
int write_gpt_table(block_dev_desc_t *dev_desc,
		  gpt_header *gpt_h, gpt_entry *gpt_e);

/**
 * gpt_fill_pte(): Fill the GPT partition table entry
 *
 * @param gpt_h - GPT header representation
 * @param gpt_e - GPT partition table entries
 * @param partitions - list of partitions
 * @param parts - number of partitions
 *
 * @return zero on success
 */
int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
		disk_partition_t *partitions, int parts);

/**
 * gpt_fill_header(): Fill the GPT header
 *
 * @param dev_desc - block device descriptor
 * @param gpt_h - GPT header representation
 * @param str_guid - disk guid string representation
 * @param parts_count - number of partitions
 *
 * @return - error on str_guid conversion error
 */
int gpt_fill_header(block_dev_desc_t *dev_desc, gpt_header *gpt_h,
		char *str_guid, int parts_count);

/**
 * gpt_restore(): Restore GPT partition table
 *
 * @param dev_desc - block device descriptor
 * @param str_disk_guid - disk GUID
 * @param partitions - list of partitions
 * @param parts - number of partitions
 *
 * @return zero on success
 */
int gpt_restore(block_dev_desc_t *dev_desc, char *str_disk_guid,
		disk_partition_t *partitions, const int parts_count);
#endif

#endif /* _PART_H */
Commit	Line	Data
012771d8	1	/*
42dfe7a1	2	* (C) Copyright 2000-2004
012771d8 WD	3	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
012771d8 WD	4	*
3765b3e7	5	* SPDX-License-Identifier: GPL-2.0+
012771d8 WD	6	*/
	7	#ifndef _PART_H
	8	#define _PART_H
735dd97b	9
6e592385	10	#include <ide.h>
012771d8 WD	11
012771d8 WD	12	typedef struct block_dev_desc {
42dfe7a1	13	int if_type; /* type of the interface */
d049cc7f WD	14	int dev; /* device number */
d049cc7f WD	15	unsigned char part_type; /* partition type */
42dfe7a1 WD	16	unsigned char target; /* target SCSI ID */
	17	unsigned char lun; /* target LUN */
	18	unsigned char type; /* device type */
	19	unsigned char removable; /* removable device */
	20	#ifdef CONFIG_LBA48
	21	unsigned char lba48; /* device can use 48bit addr (ATA/ATAPI v7) */
	22	#endif
985889b1	23	lbaint_t lba; /* number of blocks */
42dfe7a1	24	unsigned long blksz; /* block size */
0472fbfd	25	int log2blksz; /* for convenience: log2(blksz) */
d049cc7f	26	char vendor [40+1]; /* IDE model, SCSI Vendor */
2a4741d9 MZ	27	char product[20+1]; /* IDE Serial no, SCSI product */
2a4741d9 MZ	28	char revision[8+1]; /* firmware revision */
42dfe7a1	29	unsigned long (*block_read)(int dev,
ff8fef56	30	lbaint_t start,
6e592385	31	lbaint_t blkcnt,
eb867a76	32	void *buffer);
53758fa2	33	unsigned long (*block_write)(int dev,
ff8fef56	34	lbaint_t start,
53758fa2 GL	35	lbaint_t blkcnt,
53758fa2 GL	36	const void *buffer);
e6f99a56	37	unsigned long (*block_erase)(int dev,
ff8fef56	38	lbaint_t start,
e6f99a56	39	lbaint_t blkcnt);
c7057b52	40	void priv; / driver private struct pointer */
012771d8	41	}block_dev_desc_t;
b0fce99b	42
ae1768a7 EE	43	#define BLOCK_CNT(size, block_dev_desc) (PAD_COUNT(size, block_dev_desc->blksz))
	44	#define PAD_TO_BLOCKSIZE(size, block_dev_desc) \
	45	(PAD_SIZE(size, block_dev_desc->blksz))
0472fbfd EE	46	#define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
	47	((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
	48	((x & 0xffff0000) ? 16 : 0))
	49	#define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
ae1768a7	50
012771d8	51	/* Interface types: */
b0fce99b WD	52	#define IF_TYPE_UNKNOWN 0
b0fce99b WD	53	#define IF_TYPE_IDE 1
012771d8 WD	54	#define IF_TYPE_SCSI 2
012771d8 WD	55	#define IF_TYPE_ATAPI 3
b0fce99b WD	56	#define IF_TYPE_USB 4
b0fce99b WD	57	#define IF_TYPE_DOC 5
7205e407	58	#define IF_TYPE_MMC 6
c95219fa	59	#define IF_TYPE_SD 7
c7057b52	60	#define IF_TYPE_SATA 8
f4d8de48 HN	61	#define IF_TYPE_HOST 9
f4d8de48 HN	62	#define IF_TYPE_MAX 10 /* Max number of IF_TYPE_* supported */
b0fce99b	63
012771d8	64	/* Part types */
42dfe7a1	65	#define PART_TYPE_UNKNOWN 0x00
012771d8 WD	66	#define PART_TYPE_MAC 0x01
	67	#define PART_TYPE_DOS 0x02
	68	#define PART_TYPE_ISO 0x03
42dfe7a1	69	#define PART_TYPE_AMIGA 0x04
07f3d789	70	#define PART_TYPE_EFI 0x05
c7de829c	71
b0fce99b WD	72	/*
	73	* Type string for U-Boot bootable partitions
	74	*/
	75	#define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
	76	#define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
	77
012771d8	78	/* device types */
b0fce99b WD	79	#define DEV_TYPE_UNKNOWN 0xff /* not connected */
b0fce99b WD	80	#define DEV_TYPE_HARDDISK 0x00 /* harddisk */
42dfe7a1 WD	81	#define DEV_TYPE_TAPE 0x01 /* Tape */
	82	#define DEV_TYPE_CDROM 0x05 /* CD-ROM */
	83	#define DEV_TYPE_OPDISK 0x07 /* optical disk */
012771d8	84
42dfe7a1	85	typedef struct disk_partition {
04735e9c FL	86	lbaint_t start; /* # of first block in partition */
04735e9c FL	87	lbaint_t size; /* number of blocks in partition */
012771d8 WD	88	ulong blksz; /* block size in bytes */
	89	uchar name[32]; /* partition name */
	90	uchar type[32]; /* string type description */
40e0e568	91	int bootable; /* Active/Bootable flag is set */
894bfbbf SW	92	#ifdef CONFIG_PARTITION_UUIDS
	93	char uuid[37]; /* filesystem UUID as string, if exists */
	94	#endif
012771d8 WD	95	} disk_partition_t;
012771d8 WD	96
735dd97b	97	/* Misc _get_dev functions */
df3fc526	98	#ifdef CONFIG_PARTITIONS
99d2c205	99	block_dev_desc_t get_dev(const char ifname, int dev);
735dd97b	100	block_dev_desc_t* ide_get_dev(int dev);
c7057b52	101	block_dev_desc_t* sata_get_dev(int dev);
735dd97b GL	102	block_dev_desc_t* scsi_get_dev(int dev);
	103	block_dev_desc_t* usb_stor_get_dev(int dev);
	104	block_dev_desc_t* mmc_get_dev(int dev);
	105	block_dev_desc_t* systemace_get_dev(int dev);
75eb82ec	106	block_dev_desc_t* mg_disk_get_dev(int dev);
f4d8de48 HN	107	block_dev_desc_t *host_get_dev(int dev);
f4d8de48 HN	108	int host_get_dev_err(int dev, block_dev_desc_t **blk_devp);
735dd97b	109
012771d8 WD	110	/* disk/part.c */
	111	int get_partition_info (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
	112	void print_part (block_dev_desc_t *dev_desc);
	113	void init_part (block_dev_desc_t *dev_desc);
	114	void dev_print(block_dev_desc_t *dev_desc);
2023e608 SW	115	int get_device(const char ifname, const char dev_str,
2023e608 SW	116	block_dev_desc_t **dev_desc);
10a37fd7	117	int get_device_and_partition(const char ifname, const char dev_part_str,
99d2c205	118	block_dev_desc_t **dev_desc,
10a37fd7	119	disk_partition_t *info, int allow_whole_dev);
df3fc526	120	#else
99d2c205 RH	121	static inline block_dev_desc_t get_dev(const char ifname, int dev)
99d2c205 RH	122	{ return NULL; }
df3fc526 MM	123	static inline block_dev_desc_t* ide_get_dev(int dev) { return NULL; }
	124	static inline block_dev_desc_t* sata_get_dev(int dev) { return NULL; }
	125	static inline block_dev_desc_t* scsi_get_dev(int dev) { return NULL; }
	126	static inline block_dev_desc_t* usb_stor_get_dev(int dev) { return NULL; }
	127	static inline block_dev_desc_t* mmc_get_dev(int dev) { return NULL; }
	128	static inline block_dev_desc_t* systemace_get_dev(int dev) { return NULL; }
	129	static inline block_dev_desc_t* mg_disk_get_dev(int dev) { return NULL; }
f4d8de48	130	static inline block_dev_desc_t *host_get_dev(int dev) { return NULL; }
012771d8	131
df3fc526 MM	132	static inline int get_partition_info (block_dev_desc_t * dev_desc, int part,
	133	disk_partition_t *info) { return -1; }
	134	static inline void print_part (block_dev_desc_t *dev_desc) {}
	135	static inline void init_part (block_dev_desc_t *dev_desc) {}
	136	static inline void dev_print(block_dev_desc_t *dev_desc) {}
2023e608 SW	137	static inline int get_device(const char ifname, const char dev_str,
	138	block_dev_desc_t **dev_desc)
	139	{ return -1; }
99d2c205	140	static inline int get_device_and_partition(const char *ifname,
10a37fd7	141	const char *dev_part_str,
99d2c205	142	block_dev_desc_t **dev_desc,
10a37fd7 SW	143	disk_partition_t *info,
10a37fd7 SW	144	int allow_whole_dev)
99d2c205	145	{ *dev_desc = NULL; return -1; }
df3fc526	146	#endif
012771d8 WD	147
	148	#ifdef CONFIG_MAC_PARTITION
	149	/* disk/part_mac.c */
	150	int get_partition_info_mac (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
	151	void print_part_mac (block_dev_desc_t *dev_desc);
	152	int test_part_mac (block_dev_desc_t *dev_desc);
	153	#endif
	154
	155	#ifdef CONFIG_DOS_PARTITION
	156	/* disk/part_dos.c */
	157	int get_partition_info_dos (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
	158	void print_part_dos (block_dev_desc_t *dev_desc);
	159	int test_part_dos (block_dev_desc_t *dev_desc);
	160	#endif
	161
	162	#ifdef CONFIG_ISO_PARTITION
	163	/* disk/part_iso.c */
	164	int get_partition_info_iso (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
	165	void print_part_iso (block_dev_desc_t *dev_desc);
	166	int test_part_iso (block_dev_desc_t *dev_desc);
	167	#endif
	168
c7de829c WD	169	#ifdef CONFIG_AMIGA_PARTITION
	170	/* disk/part_amiga.c */
	171	int get_partition_info_amiga (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
	172	void print_part_amiga (block_dev_desc_t *dev_desc);
	173	int test_part_amiga (block_dev_desc_t *dev_desc);
	174	#endif
	175
07f3d789	176	#ifdef CONFIG_EFI_PARTITION
40684ddb	177	#include <part_efi.h>
07f3d789	178	/* disk/part_efi.c */
	179	int get_partition_info_efi (block_dev_desc_t * dev_desc, int part, disk_partition_t *info);
	180	void print_part_efi (block_dev_desc_t *dev_desc);
	181	int test_part_efi (block_dev_desc_t *dev_desc);
40684ddb ŁM	182
	183	/**
	184	* write_gpt_table() - Write the GUID Partition Table to disk
	185	*
	186	* @param dev_desc - block device descriptor
	187	* @param gpt_h - pointer to GPT header representation
	188	* @param gpt_e - pointer to GPT partition table entries
	189	*
	190	* @return - zero on success, otherwise error
	191	*/
	192	int write_gpt_table(block_dev_desc_t *dev_desc,
	193	gpt_header gpt_h, gpt_entry gpt_e);
	194
	195	/**
	196	* gpt_fill_pte(): Fill the GPT partition table entry
	197	*
	198	* @param gpt_h - GPT header representation
	199	* @param gpt_e - GPT partition table entries
	200	* @param partitions - list of partitions
	201	* @param parts - number of partitions
	202	*
	203	* @return zero on success
	204	*/
	205	int gpt_fill_pte(gpt_header gpt_h, gpt_entry gpt_e,
	206	disk_partition_t *partitions, int parts);
	207
	208	/**
	209	* gpt_fill_header(): Fill the GPT header
	210	*
	211	* @param dev_desc - block device descriptor
	212	* @param gpt_h - GPT header representation
	213	* @param str_guid - disk guid string representation
	214	* @param parts_count - number of partitions
	215	*
	216	* @return - error on str_guid conversion error
	217	*/
	218	int gpt_fill_header(block_dev_desc_t dev_desc, gpt_header gpt_h,
	219	char *str_guid, int parts_count);
	220
	221	/**
	222	* gpt_restore(): Restore GPT partition table
	223	*
	224	* @param dev_desc - block device descriptor
	225	* @param str_disk_guid - disk GUID
	226	* @param partitions - list of partitions
	227	* @param parts - number of partitions
	228	*
	229	* @return zero on success
	230	*/
	231	int gpt_restore(block_dev_desc_t dev_desc, char str_disk_guid,
	232	disk_partition_t *partitions, const int parts_count);
07f3d789	233	#endif
07f3d789	234
012771d8	235	#endif /* _PART_H */