part.h 17 KB

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