part.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2000-2004
  4. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  5. */
  6. #ifndef _PART_H
  7. #define _PART_H
  8. #include <blk.h>
  9. #include <ide.h>
  10. #include <uuid.h>
  11. #include <linux/list.h>
  12. struct block_drvr {
  13. char *name;
  14. int (*select_hwpart)(int dev_num, int hwpart);
  15. };
  16. #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
  17. ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
  18. ((x & 0xffff0000) ? 16 : 0))
  19. #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
  20. /* Part types */
  21. #define PART_TYPE_UNKNOWN 0x00
  22. #define PART_TYPE_MAC 0x01
  23. #define PART_TYPE_DOS 0x02
  24. #define PART_TYPE_ISO 0x03
  25. #define PART_TYPE_AMIGA 0x04
  26. #define PART_TYPE_EFI 0x05
  27. /* maximum number of partition entries supported by search */
  28. #define DOS_ENTRY_NUMBERS 8
  29. #define ISO_ENTRY_NUMBERS 64
  30. #define MAC_ENTRY_NUMBERS 64
  31. #define AMIGA_ENTRY_NUMBERS 8
  32. /*
  33. * Type string for U-Boot bootable partitions
  34. */
  35. #define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
  36. #define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
  37. /* device types */
  38. #define DEV_TYPE_UNKNOWN 0xff /* not connected */
  39. #define DEV_TYPE_HARDDISK 0x00 /* harddisk */
  40. #define DEV_TYPE_TAPE 0x01 /* Tape */
  41. #define DEV_TYPE_CDROM 0x05 /* CD-ROM */
  42. #define DEV_TYPE_OPDISK 0x07 /* optical disk */
  43. #define PART_NAME_LEN 32
  44. #define PART_TYPE_LEN 32
  45. #define MAX_SEARCH_PARTITIONS 64
  46. #define PART_BOOTABLE ((int)BIT(0))
  47. #define PART_EFI_SYSTEM_PARTITION ((int)BIT(1))
  48. typedef struct disk_partition {
  49. lbaint_t start; /* # of first block in partition */
  50. lbaint_t size; /* number of blocks in partition */
  51. ulong blksz; /* block size in bytes */
  52. uchar name[PART_NAME_LEN]; /* partition name */
  53. uchar type[PART_TYPE_LEN]; /* string type description */
  54. /*
  55. * The bootable is a bitmask with the following fields:
  56. *
  57. * PART_BOOTABLE the MBR bootable flag is set
  58. * PART_EFI_SYSTEM_PARTITION the partition is an EFI system partition
  59. */
  60. int bootable;
  61. #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
  62. char uuid[UUID_STR_LEN + 1]; /* filesystem UUID as string, if exists */
  63. #endif
  64. #ifdef CONFIG_PARTITION_TYPE_GUID
  65. char type_guid[UUID_STR_LEN + 1]; /* type GUID as string, if exists */
  66. #endif
  67. #ifdef CONFIG_DOS_PARTITION
  68. uchar sys_ind; /* partition type */
  69. #endif
  70. } disk_partition_t;
  71. struct disk_part {
  72. int partnum;
  73. disk_partition_t gpt_part_info;
  74. struct list_head list;
  75. };
  76. /* Misc _get_dev functions */
  77. #ifdef CONFIG_PARTITIONS
  78. /**
  79. * blk_get_dev() - get a pointer to a block device given its type and number
  80. *
  81. * Each interface allocates its own devices and typically struct blk_desc is
  82. * contained with the interface's data structure. There is no global
  83. * numbering for block devices, so the interface name must be provided.
  84. *
  85. * @ifname: Interface name (e.g. "ide", "scsi")
  86. * @dev: Device number (0 for first device on that interface, 1 for
  87. * second, etc.
  88. * @return pointer to the block device, or NULL if not available, or an
  89. * error occurred.
  90. */
  91. struct blk_desc *blk_get_dev(const char *ifname, int dev);
  92. struct blk_desc *mg_disk_get_dev(int dev);
  93. int host_get_dev_err(int dev, struct blk_desc **blk_devp);
  94. /* disk/part.c */
  95. int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
  96. /**
  97. * part_get_info_whole_disk() - get partition info for the special case of
  98. * a partition occupying the entire disk.
  99. */
  100. int part_get_info_whole_disk(struct blk_desc *dev_desc, disk_partition_t *info);
  101. void part_print(struct blk_desc *dev_desc);
  102. void part_init(struct blk_desc *dev_desc);
  103. void dev_print(struct blk_desc *dev_desc);
  104. /**
  105. * blk_get_device_by_str() - Get a block device given its interface/hw partition
  106. *
  107. * Each interface allocates its own devices and typically struct blk_desc is
  108. * contained with the interface's data structure. There is no global
  109. * numbering for block devices, so the interface name must be provided.
  110. *
  111. * The hardware parition is not related to the normal software partitioning
  112. * of a device - each hardware partition is effectively a separately
  113. * accessible block device. When a hardware parition is selected on MMC the
  114. * other hardware partitions become inaccessible. The same block device is
  115. * used to access all hardware partitions, but its capacity may change when a
  116. * different hardware partition is selected.
  117. *
  118. * When a hardware partition number is given, the block device switches to
  119. * that hardware partition.
  120. *
  121. * @ifname: Interface name (e.g. "ide", "scsi")
  122. * @dev_str: Device and optional hw partition. This can either be a string
  123. * containing the device number (e.g. "2") or the device number
  124. * and hardware partition number (e.g. "2.4") for devices that
  125. * support it (currently only MMC).
  126. * @dev_desc: Returns a pointer to the block device on success
  127. * @return block device number (local to the interface), or -1 on error
  128. */
  129. int blk_get_device_by_str(const char *ifname, const char *dev_str,
  130. struct blk_desc **dev_desc);
  131. /**
  132. * blk_get_device_part_str() - Get a block device and partition
  133. *
  134. * This calls blk_get_device_by_str() to look up a device. It also looks up
  135. * a partition and returns information about it.
  136. *
  137. * @dev_part_str is in the format:
  138. * <dev>.<hw_part>:<part> where <dev> is the device number,
  139. * <hw_part> is the optional hardware partition number and
  140. * <part> is the partition number
  141. *
  142. * If ifname is "hostfs" then this function returns the sandbox host block
  143. * device.
  144. *
  145. * If ifname is ubi, then this function returns 0, with @info set to a
  146. * special UBI device.
  147. *
  148. * If @dev_part_str is NULL or empty or "-", then this function looks up
  149. * the "bootdevice" environment variable and uses that string instead.
  150. *
  151. * If the partition string is empty then the first partition is used. If the
  152. * partition string is "auto" then the first bootable partition is used.
  153. *
  154. * @ifname: Interface name (e.g. "ide", "scsi")
  155. * @dev_part_str: Device and partition string
  156. * @dev_desc: Returns a pointer to the block device on success
  157. * @info: Returns partition information
  158. * @allow_whole_dev: true to allow the user to select partition 0
  159. * (which means the whole device), false to require a valid
  160. * partition number >= 1
  161. * @return partition number, or -1 on error
  162. *
  163. */
  164. int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
  165. struct blk_desc **dev_desc,
  166. disk_partition_t *info, int allow_whole_dev);
  167. /**
  168. * part_get_info_by_name_type() - Search for a partition by name
  169. * for only specified partition type
  170. *
  171. * @param dev_desc - block device descriptor
  172. * @param gpt_name - the specified table entry name
  173. * @param info - returns the disk partition info
  174. * @param part_type - only search in partitions of this type
  175. *
  176. * @return - the partition number on match (starting on 1), -1 on no match,
  177. * otherwise error
  178. */
  179. int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
  180. disk_partition_t *info, int part_type);
  181. /**
  182. * part_get_info_by_name() - Search for a partition by name
  183. * among all available registered partitions
  184. *
  185. * @param dev_desc - block device descriptor
  186. * @param gpt_name - the specified table entry name
  187. * @param info - returns the disk partition info
  188. *
  189. * @return - the partition number on match (starting on 1), -1 on no match,
  190. * otherwise error
  191. */
  192. int part_get_info_by_name(struct blk_desc *dev_desc,
  193. const char *name, disk_partition_t *info);
  194. /**
  195. * Get partition info from dev number + part name, or dev number + part number.
  196. *
  197. * Parse a device number and partition description (either name or number)
  198. * in the form of device number plus partition name separated by a "#"
  199. * (like "device_num#partition_name") or a device number plus a partition number
  200. * separated by a ":". For example both "0#misc" and "0:1" can be valid
  201. * partition descriptions for a given interface. If the partition is found, sets
  202. * dev_desc and part_info accordingly with the information of the partition.
  203. *
  204. * @param[in] dev_iface Device interface
  205. * @param[in] dev_part_str Input partition description, like "0#misc" or "0:1"
  206. * @param[out] dev_desc Place to store the device description pointer
  207. * @param[out] part_info Place to store the partition information
  208. * @return 0 on success, or a negative on error
  209. */
  210. int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
  211. const char *dev_part_str,
  212. struct blk_desc **dev_desc,
  213. disk_partition_t *part_info);
  214. /**
  215. * part_set_generic_name() - create generic partition like hda1 or sdb2
  216. *
  217. * Helper function for partition tables, which don't hold partition names
  218. * (DOS, ISO). Generates partition name out of the device type and partition
  219. * number.
  220. *
  221. * @dev_desc: pointer to the block device
  222. * @part_num: partition number for which the name is generated
  223. * @name: buffer where the name is written
  224. */
  225. void part_set_generic_name(const struct blk_desc *dev_desc,
  226. int part_num, char *name);
  227. extern const struct block_drvr block_drvr[];
  228. #else
  229. static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
  230. { return NULL; }
  231. static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
  232. static inline int part_get_info(struct blk_desc *dev_desc, int part,
  233. disk_partition_t *info) { return -1; }
  234. static inline int part_get_info_whole_disk(struct blk_desc *dev_desc,
  235. disk_partition_t *info)
  236. { return -1; }
  237. static inline void part_print(struct blk_desc *dev_desc) {}
  238. static inline void part_init(struct blk_desc *dev_desc) {}
  239. static inline void dev_print(struct blk_desc *dev_desc) {}
  240. static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
  241. struct blk_desc **dev_desc)
  242. { return -1; }
  243. static inline int blk_get_device_part_str(const char *ifname,
  244. const char *dev_part_str,
  245. struct blk_desc **dev_desc,
  246. disk_partition_t *info,
  247. int allow_whole_dev)
  248. { *dev_desc = NULL; return -1; }
  249. #endif
  250. /*
  251. * We don't support printing partition information in SPL and only support
  252. * getting partition information in a few cases.
  253. */
  254. #ifdef CONFIG_SPL_BUILD
  255. # define part_print_ptr(x) NULL
  256. # if defined(CONFIG_SPL_FS_EXT4) || defined(CONFIG_SPL_FS_FAT) || \
  257. defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
  258. # define part_get_info_ptr(x) x
  259. # else
  260. # define part_get_info_ptr(x) NULL
  261. # endif
  262. #else
  263. #define part_print_ptr(x) x
  264. #define part_get_info_ptr(x) x
  265. #endif
  266. struct part_driver {
  267. const char *name;
  268. int part_type;
  269. const int max_entries; /* maximum number of entries to search */
  270. /**
  271. * get_info() - Get information about a partition
  272. *
  273. * @dev_desc: Block device descriptor
  274. * @part: Partition number (1 = first)
  275. * @info: Returns partition information
  276. */
  277. int (*get_info)(struct blk_desc *dev_desc, int part,
  278. disk_partition_t *info);
  279. /**
  280. * print() - Print partition information
  281. *
  282. * @dev_desc: Block device descriptor
  283. */
  284. void (*print)(struct blk_desc *dev_desc);
  285. /**
  286. * test() - Test if a device contains this partition type
  287. *
  288. * @dev_desc: Block device descriptor
  289. * @return 0 if the block device appears to contain this partition
  290. * type, -ve if not
  291. */
  292. int (*test)(struct blk_desc *dev_desc);
  293. };
  294. /* Declare a new U-Boot partition 'driver' */
  295. #define U_BOOT_PART_TYPE(__name) \
  296. ll_entry_declare(struct part_driver, __name, part_driver)
  297. #include <part_efi.h>
  298. #if CONFIG_IS_ENABLED(EFI_PARTITION)
  299. /* disk/part_efi.c */
  300. /**
  301. * write_gpt_table() - Write the GUID Partition Table to disk
  302. *
  303. * @param dev_desc - block device descriptor
  304. * @param gpt_h - pointer to GPT header representation
  305. * @param gpt_e - pointer to GPT partition table entries
  306. *
  307. * @return - zero on success, otherwise error
  308. */
  309. int write_gpt_table(struct blk_desc *dev_desc,
  310. gpt_header *gpt_h, gpt_entry *gpt_e);
  311. /**
  312. * gpt_fill_pte(): Fill the GPT partition table entry
  313. *
  314. * @param dev_desc - block device descriptor
  315. * @param gpt_h - GPT header representation
  316. * @param gpt_e - GPT partition table entries
  317. * @param partitions - list of partitions
  318. * @param parts - number of partitions
  319. *
  320. * @return zero on success
  321. */
  322. int gpt_fill_pte(struct blk_desc *dev_desc,
  323. gpt_header *gpt_h, gpt_entry *gpt_e,
  324. disk_partition_t *partitions, int parts);
  325. /**
  326. * gpt_fill_header(): Fill the GPT header
  327. *
  328. * @param dev_desc - block device descriptor
  329. * @param gpt_h - GPT header representation
  330. * @param str_guid - disk guid string representation
  331. * @param parts_count - number of partitions
  332. *
  333. * @return - error on str_guid conversion error
  334. */
  335. int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
  336. char *str_guid, int parts_count);
  337. /**
  338. * gpt_restore(): Restore GPT partition table
  339. *
  340. * @param dev_desc - block device descriptor
  341. * @param str_disk_guid - disk GUID
  342. * @param partitions - list of partitions
  343. * @param parts - number of partitions
  344. *
  345. * @return zero on success
  346. */
  347. int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
  348. disk_partition_t *partitions, const int parts_count);
  349. /**
  350. * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
  351. *
  352. * @param dev_desc - block device descriptor
  353. * @param buf - buffer which contains the MBR and Primary GPT info
  354. *
  355. * @return - '0' on success, otherwise error
  356. */
  357. int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
  358. /**
  359. * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
  360. *
  361. * @param dev_desc - block device descriptor
  362. * @param buf - buffer which contains the MBR and Primary GPT info
  363. *
  364. * @return - '0' on success, otherwise error
  365. */
  366. int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
  367. /**
  368. * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
  369. * and partition table entries (PTE)
  370. *
  371. * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
  372. *
  373. * @param dev_desc - block device descriptor
  374. * @param gpt_head - pointer to GPT header data read from medium
  375. * @param gpt_pte - pointer to GPT partition table enties read from medium
  376. *
  377. * @return - '0' on success, otherwise error
  378. */
  379. int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
  380. gpt_entry **gpt_pte);
  381. /**
  382. * gpt_verify_partitions() - Function to check if partitions' name, start and
  383. * size correspond to '$partitions' env variable
  384. *
  385. * This function checks if on medium stored GPT data is in sync with information
  386. * provided in '$partitions' environment variable. Specificially, name, start
  387. * and size of the partition is checked.
  388. *
  389. * @param dev_desc - block device descriptor
  390. * @param partitions - partition data read from '$partitions' env variable
  391. * @param parts - number of partitions read from '$partitions' env variable
  392. * @param gpt_head - pointer to GPT header data read from medium
  393. * @param gpt_pte - pointer to GPT partition table enties read from medium
  394. *
  395. * @return - '0' on success, otherwise error
  396. */
  397. int gpt_verify_partitions(struct blk_desc *dev_desc,
  398. disk_partition_t *partitions, int parts,
  399. gpt_header *gpt_head, gpt_entry **gpt_pte);
  400. /**
  401. * get_disk_guid() - Function to read the GUID string from a device's GPT
  402. *
  403. * This function reads the GUID string from a block device whose descriptor
  404. * is provided.
  405. *
  406. * @param dev_desc - block device descriptor
  407. * @param guid - pre-allocated string in which to return the GUID
  408. *
  409. * @return - '0' on success, otherwise error
  410. */
  411. int get_disk_guid(struct blk_desc *dev_desc, char *guid);
  412. #endif
  413. #if CONFIG_IS_ENABLED(DOS_PARTITION)
  414. /**
  415. * is_valid_dos_buf() - Ensure that a DOS MBR image is valid
  416. *
  417. * @param buf - buffer which contains the MBR
  418. *
  419. * @return - '0' on success, otherwise error
  420. */
  421. int is_valid_dos_buf(void *buf);
  422. /**
  423. * write_mbr_partition() - write DOS MBR
  424. *
  425. * @param dev_desc - block device descriptor
  426. * @param buf - buffer which contains the MBR
  427. *
  428. * @return - '0' on success, otherwise error
  429. */
  430. int write_mbr_partition(struct blk_desc *dev_desc, void *buf);
  431. #endif
  432. #endif /* _PART_H */