[mirror_ubuntu-bionic-kernel.git] / include / linux / edd.h

/*
 * linux/include/linux/edd.h
 *  Copyright (C) 2002, 2003, 2004 Dell Inc.
 *  by Matt Domsch <Matt_Domsch@dell.com>
 *
 * structures and definitions for the int 13h, ax={41,48}h
 * BIOS Enhanced Disk Drive Services
 * This is based on the T13 group document D1572 Revision 0 (August 14 2002)
 * available at http://www.t13.org/docs2002/d1572r0.pdf.  It is
 * very similar to D1484 Revision 3 http://www.t13.org/docs2002/d1484r3.pdf
 *
 * In a nutshell, arch/{i386,x86_64}/boot/setup.S populates a scratch
 * table in the boot_params that contains a list of BIOS-enumerated
 * boot devices.
 * In arch/{i386,x86_64}/kernel/setup.c, this information is
 * transferred into the edd structure, and in drivers/firmware/edd.c, that
 * information is used to identify BIOS boot disk.  The code in setup.S
 * is very sensitive to the size of these structures.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License v2.0 as published by
 * the Free Software Foundation
 *
 * 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.
 *
 */
#ifndef _LINUX_EDD_H
#define _LINUX_EDD_H

#include <linux/types.h>

#define EDDNR 0x1e9		/* addr of number of edd_info structs at EDDBUF
				   in boot_params - treat this as 1 byte  */
#define EDDBUF	0xd00		/* addr of edd_info structs in boot_params */
#define EDDMAXNR 6		/* number of edd_info structs starting at EDDBUF  */
#define EDDEXTSIZE 8		/* change these if you muck with the structures */
#define EDDPARMSIZE 74
#define CHECKEXTENSIONSPRESENT 0x41
#define GETDEVICEPARAMETERS 0x48
#define LEGACYGETDEVICEPARAMETERS 0x08
#define EDDMAGIC1 0x55AA
#define EDDMAGIC2 0xAA55


#define READ_SECTORS 0x02         /* int13 AH=0x02 is READ_SECTORS command */
#define EDD_MBR_SIG_OFFSET 0x1B8  /* offset of signature in the MBR */
#define EDD_MBR_SIG_BUF    0x290  /* addr in boot params */
#define EDD_MBR_SIG_MAX 16        /* max number of signatures to store */
#define EDD_MBR_SIG_NR_BUF 0x1ea  /* addr of number of MBR signtaures at EDD_MBR_SIG_BUF
				     in boot_params - treat this as 1 byte  */

#ifndef __ASSEMBLY__

#define EDD_EXT_FIXED_DISK_ACCESS           (1 << 0)
#define EDD_EXT_DEVICE_LOCKING_AND_EJECTING (1 << 1)
#define EDD_EXT_ENHANCED_DISK_DRIVE_SUPPORT (1 << 2)
#define EDD_EXT_64BIT_EXTENSIONS            (1 << 3)

#define EDD_INFO_DMA_BOUNDARY_ERROR_TRANSPARENT (1 << 0)
#define EDD_INFO_GEOMETRY_VALID                (1 << 1)
#define EDD_INFO_REMOVABLE                     (1 << 2)
#define EDD_INFO_WRITE_VERIFY                  (1 << 3)
#define EDD_INFO_MEDIA_CHANGE_NOTIFICATION     (1 << 4)
#define EDD_INFO_LOCKABLE                      (1 << 5)
#define EDD_INFO_NO_MEDIA_PRESENT              (1 << 6)
#define EDD_INFO_USE_INT13_FN50                (1 << 7)

struct edd_device_params {
	__u16 length;
	__u16 info_flags;
	__u32 num_default_cylinders;
	__u32 num_default_heads;
	__u32 sectors_per_track;
	__u64 number_of_sectors;
	__u16 bytes_per_sector;
	__u32 dpte_ptr;		/* 0xFFFFFFFF for our purposes */
	__u16 key;		/* = 0xBEDD */
	__u8 device_path_info_length;	/* = 44 */
	__u8 reserved2;
	__u16 reserved3;
	__u8 host_bus_type[4];
	__u8 interface_type[8];
	union {
		struct {
			__u16 base_address;
			__u16 reserved1;
			__u32 reserved2;
		} __attribute__ ((packed)) isa;
		struct {
			__u8 bus;
			__u8 slot;
			__u8 function;
			__u8 channel;
			__u32 reserved;
		} __attribute__ ((packed)) pci;
		/* pcix is same as pci */
		struct {
			__u64 reserved;
		} __attribute__ ((packed)) ibnd;
		struct {
			__u64 reserved;
		} __attribute__ ((packed)) xprs;
		struct {
			__u64 reserved;
		} __attribute__ ((packed)) htpt;
		struct {
			__u64 reserved;
		} __attribute__ ((packed)) unknown;
	} interface_path;
	union {
		struct {
			__u8 device;
			__u8 reserved1;
			__u16 reserved2;
			__u32 reserved3;
			__u64 reserved4;
		} __attribute__ ((packed)) ata;
		struct {
			__u8 device;
			__u8 lun;
			__u8 reserved1;
			__u8 reserved2;
			__u32 reserved3;
			__u64 reserved4;
		} __attribute__ ((packed)) atapi;
		struct {
			__u16 id;
			__u64 lun;
			__u16 reserved1;
			__u32 reserved2;
		} __attribute__ ((packed)) scsi;
		struct {
			__u64 serial_number;
			__u64 reserved;
		} __attribute__ ((packed)) usb;
		struct {
			__u64 eui;
			__u64 reserved;
		} __attribute__ ((packed)) i1394;
		struct {
			__u64 wwid;
			__u64 lun;
		} __attribute__ ((packed)) fibre;
		struct {
			__u64 identity_tag;
			__u64 reserved;
		} __attribute__ ((packed)) i2o;
		struct {
			__u32 array_number;
			__u32 reserved1;
			__u64 reserved2;
		} __attribute__ ((packed)) raid;
		struct {
			__u8 device;
			__u8 reserved1;
			__u16 reserved2;
			__u32 reserved3;
			__u64 reserved4;
		} __attribute__ ((packed)) sata;
		struct {
			__u64 reserved1;
			__u64 reserved2;
		} __attribute__ ((packed)) unknown;
	} device_path;
	__u8 reserved4;
	__u8 checksum;
} __attribute__ ((packed));

struct edd_info {
	__u8 device;
	__u8 version;
	__u16 interface_support;
	__u16 legacy_max_cylinder;
	__u8 legacy_max_head;
	__u8 legacy_sectors_per_track;
	struct edd_device_params params;
} __attribute__ ((packed));

struct edd {
	unsigned int mbr_signature[EDD_MBR_SIG_MAX];
	struct edd_info edd_info[EDDMAXNR];
	unsigned char mbr_signature_nr;
	unsigned char edd_info_nr;
};

#ifdef __KERNEL__
extern struct edd edd;
#endif /* __KERNEL__ */
#endif				/*!__ASSEMBLY__ */

#endif				/* _LINUX_EDD_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/edd.h
	3	* Copyright (C) 2002, 2003, 2004 Dell Inc.
	4	* by Matt Domsch <Matt_Domsch@dell.com>
	5	*
	6	* structures and definitions for the int 13h, ax={41,48}h
	7	* BIOS Enhanced Disk Drive Services
	8	* This is based on the T13 group document D1572 Revision 0 (August 14 2002)
	9	* available at http://www.t13.org/docs2002/d1572r0.pdf. It is
	10	* very similar to D1484 Revision 3 http://www.t13.org/docs2002/d1484r3.pdf
	11	*
	12	* In a nutshell, arch/{i386,x86_64}/boot/setup.S populates a scratch
	13	* table in the boot_params that contains a list of BIOS-enumerated
	14	* boot devices.
	15	* In arch/{i386,x86_64}/kernel/setup.c, this information is
	16	* transferred into the edd structure, and in drivers/firmware/edd.c, that
	17	* information is used to identify BIOS boot disk. The code in setup.S
	18	* is very sensitive to the size of these structures.
	19	*
	20	* This program is free software; you can redistribute it and/or modify
	21	* it under the terms of the GNU General Public License v2.0 as published by
	22	* the Free Software Foundation
	23	*
	24	* This program is distributed in the hope that it will be useful,
	25	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	26	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	27	* GNU General Public License for more details.
	28	*
	29	*/
	30	#ifndef _LINUX_EDD_H
	31	#define _LINUX_EDD_H
	32
41441470 JSR	33	#include <linux/types.h>
41441470 JSR	34
1da177e4 LT	35	#define EDDNR 0x1e9 /* addr of number of edd_info structs at EDDBUF
1da177e4 LT	36	in boot_params - treat this as 1 byte */
f9ba7053	37	#define EDDBUF 0xd00 /* addr of edd_info structs in boot_params */
1da177e4 LT	38	#define EDDMAXNR 6 /* number of edd_info structs starting at EDDBUF */
	39	#define EDDEXTSIZE 8 /* change these if you muck with the structures */
	40	#define EDDPARMSIZE 74
	41	#define CHECKEXTENSIONSPRESENT 0x41
	42	#define GETDEVICEPARAMETERS 0x48
	43	#define LEGACYGETDEVICEPARAMETERS 0x08
	44	#define EDDMAGIC1 0x55AA
	45	#define EDDMAGIC2 0xAA55
	46
	47
	48	#define READ_SECTORS 0x02 /* int13 AH=0x02 is READ_SECTORS command */
	49	#define EDD_MBR_SIG_OFFSET 0x1B8 /* offset of signature in the MBR */
	50	#define EDD_MBR_SIG_BUF 0x290 /* addr in boot params */
	51	#define EDD_MBR_SIG_MAX 16 /* max number of signatures to store */
	52	#define EDD_MBR_SIG_NR_BUF 0x1ea /* addr of number of MBR signtaures at EDD_MBR_SIG_BUF
	53	in boot_params - treat this as 1 byte */
1da177e4 LT	54
	55	#ifndef __ASSEMBLY__
	56
	57	#define EDD_EXT_FIXED_DISK_ACCESS (1 << 0)
	58	#define EDD_EXT_DEVICE_LOCKING_AND_EJECTING (1 << 1)
	59	#define EDD_EXT_ENHANCED_DISK_DRIVE_SUPPORT (1 << 2)
	60	#define EDD_EXT_64BIT_EXTENSIONS (1 << 3)
	61
	62	#define EDD_INFO_DMA_BOUNDARY_ERROR_TRANSPARENT (1 << 0)
	63	#define EDD_INFO_GEOMETRY_VALID (1 << 1)
	64	#define EDD_INFO_REMOVABLE (1 << 2)
	65	#define EDD_INFO_WRITE_VERIFY (1 << 3)
	66	#define EDD_INFO_MEDIA_CHANGE_NOTIFICATION (1 << 4)
	67	#define EDD_INFO_LOCKABLE (1 << 5)
	68	#define EDD_INFO_NO_MEDIA_PRESENT (1 << 6)
	69	#define EDD_INFO_USE_INT13_FN50 (1 << 7)
	70
	71	struct edd_device_params {
ee8e7cfe RR	72	__u16 length;
	73	__u16 info_flags;
	74	__u32 num_default_cylinders;
	75	__u32 num_default_heads;
	76	__u32 sectors_per_track;
	77	__u64 number_of_sectors;
	78	__u16 bytes_per_sector;
	79	__u32 dpte_ptr; /* 0xFFFFFFFF for our purposes */
	80	__u16 key; /* = 0xBEDD */
	81	__u8 device_path_info_length; /* = 44 */
	82	__u8 reserved2;
	83	__u16 reserved3;
	84	__u8 host_bus_type[4];
	85	__u8 interface_type[8];
1da177e4 LT	86	union {
1da177e4 LT	87	struct {
ee8e7cfe RR	88	__u16 base_address;
	89	__u16 reserved1;
	90	__u32 reserved2;
1da177e4 LT	91	} __attribute__ ((packed)) isa;
1da177e4 LT	92	struct {
ee8e7cfe RR	93	__u8 bus;
	94	__u8 slot;
	95	__u8 function;
	96	__u8 channel;
	97	__u32 reserved;
1da177e4 LT	98	} __attribute__ ((packed)) pci;
	99	/* pcix is same as pci */
	100	struct {
ee8e7cfe	101	__u64 reserved;
1da177e4 LT	102	} __attribute__ ((packed)) ibnd;
1da177e4 LT	103	struct {
ee8e7cfe	104	__u64 reserved;
1da177e4 LT	105	} __attribute__ ((packed)) xprs;
1da177e4 LT	106	struct {
ee8e7cfe	107	__u64 reserved;
1da177e4 LT	108	} __attribute__ ((packed)) htpt;
1da177e4 LT	109	struct {
ee8e7cfe	110	__u64 reserved;
1da177e4 LT	111	} __attribute__ ((packed)) unknown;
	112	} interface_path;
	113	union {
	114	struct {
ee8e7cfe RR	115	__u8 device;
	116	__u8 reserved1;
	117	__u16 reserved2;
	118	__u32 reserved3;
	119	__u64 reserved4;
1da177e4 LT	120	} __attribute__ ((packed)) ata;
1da177e4 LT	121	struct {
ee8e7cfe RR	122	__u8 device;
	123	__u8 lun;
	124	__u8 reserved1;
	125	__u8 reserved2;
	126	__u32 reserved3;
	127	__u64 reserved4;
1da177e4 LT	128	} __attribute__ ((packed)) atapi;
1da177e4 LT	129	struct {
ee8e7cfe RR	130	__u16 id;
	131	__u64 lun;
	132	__u16 reserved1;
	133	__u32 reserved2;
1da177e4 LT	134	} __attribute__ ((packed)) scsi;
1da177e4 LT	135	struct {
ee8e7cfe RR	136	__u64 serial_number;
ee8e7cfe RR	137	__u64 reserved;
1da177e4 LT	138	} __attribute__ ((packed)) usb;
1da177e4 LT	139	struct {
ee8e7cfe RR	140	__u64 eui;
ee8e7cfe RR	141	__u64 reserved;
1da177e4 LT	142	} __attribute__ ((packed)) i1394;
1da177e4 LT	143	struct {
ee8e7cfe RR	144	__u64 wwid;
ee8e7cfe RR	145	__u64 lun;
1da177e4 LT	146	} __attribute__ ((packed)) fibre;
1da177e4 LT	147	struct {
ee8e7cfe RR	148	__u64 identity_tag;
ee8e7cfe RR	149	__u64 reserved;
1da177e4 LT	150	} __attribute__ ((packed)) i2o;
1da177e4 LT	151	struct {
ee8e7cfe RR	152	__u32 array_number;
	153	__u32 reserved1;
	154	__u64 reserved2;
1da177e4 LT	155	} __attribute__ ((packed)) raid;
1da177e4 LT	156	struct {
ee8e7cfe RR	157	__u8 device;
	158	__u8 reserved1;
	159	__u16 reserved2;
	160	__u32 reserved3;
	161	__u64 reserved4;
1da177e4 LT	162	} __attribute__ ((packed)) sata;
1da177e4 LT	163	struct {
ee8e7cfe RR	164	__u64 reserved1;
ee8e7cfe RR	165	__u64 reserved2;
1da177e4 LT	166	} __attribute__ ((packed)) unknown;
1da177e4 LT	167	} device_path;
ee8e7cfe RR	168	__u8 reserved4;
ee8e7cfe RR	169	__u8 checksum;
1da177e4 LT	170	} __attribute__ ((packed));
	171
	172	struct edd_info {
ee8e7cfe RR	173	__u8 device;
	174	__u8 version;
	175	__u16 interface_support;
	176	__u16 legacy_max_cylinder;
	177	__u8 legacy_max_head;
	178	__u8 legacy_sectors_per_track;
1da177e4 LT	179	struct edd_device_params params;
	180	} __attribute__ ((packed));
	181
	182	struct edd {
	183	unsigned int mbr_signature[EDD_MBR_SIG_MAX];
	184	struct edd_info edd_info[EDDMAXNR];
	185	unsigned char mbr_signature_nr;
	186	unsigned char edd_info_nr;
	187	};
	188
ee8e7cfe	189	#ifdef __KERNEL__
1da177e4	190	extern struct edd edd;
ee8e7cfe	191	#endif /* __KERNEL__ */
1da177e4 LT	192	#endif /!__ASSEMBLY__ /
	193
	194	#endif /* _LINUX_EDD_H */