part.h 15 KB

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