part.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  1. /*
  2. * (C) Copyright 2000-2004
  3. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  4. *
  5. * SPDX-License-Identifier: GPL-2.0+
  6. */
  7. #ifndef _PART_H
  8. #define _PART_H
  9. #include <blk.h>
  10. #include <ide.h>
  11. struct block_drvr {
  12. char *name;
  13. int (*select_hwpart)(int dev_num, int hwpart);
  14. };
  15. #define LOG2(x) (((x & 0xaaaaaaaa) ? 1 : 0) + ((x & 0xcccccccc) ? 2 : 0) + \
  16. ((x & 0xf0f0f0f0) ? 4 : 0) + ((x & 0xff00ff00) ? 8 : 0) + \
  17. ((x & 0xffff0000) ? 16 : 0))
  18. #define LOG2_INVALID(type) ((type)((sizeof(type)<<3)-1))
  19. /* Part types */
  20. #define PART_TYPE_UNKNOWN 0x00
  21. #define PART_TYPE_MAC 0x01
  22. #define PART_TYPE_DOS 0x02
  23. #define PART_TYPE_ISO 0x03
  24. #define PART_TYPE_AMIGA 0x04
  25. #define PART_TYPE_EFI 0x05
  26. /* maximum number of partition entries supported by search */
  27. #define DOS_ENTRY_NUMBERS 8
  28. #define ISO_ENTRY_NUMBERS 64
  29. #define MAC_ENTRY_NUMBERS 64
  30. #define AMIGA_ENTRY_NUMBERS 8
  31. /*
  32. * Type string for U-Boot bootable partitions
  33. */
  34. #define BOOT_PART_TYPE "U-Boot" /* primary boot partition type */
  35. #define BOOT_PART_COMP "PPCBoot" /* PPCBoot compatibility type */
  36. /* device types */
  37. #define DEV_TYPE_UNKNOWN 0xff /* not connected */
  38. #define DEV_TYPE_HARDDISK 0x00 /* harddisk */
  39. #define DEV_TYPE_TAPE 0x01 /* Tape */
  40. #define DEV_TYPE_CDROM 0x05 /* CD-ROM */
  41. #define DEV_TYPE_OPDISK 0x07 /* optical disk */
  42. typedef struct disk_partition {
  43. lbaint_t start; /* # of first block in partition */
  44. lbaint_t size; /* number of blocks in partition */
  45. ulong blksz; /* block size in bytes */
  46. uchar name[32]; /* partition name */
  47. uchar type[32]; /* string type description */
  48. int bootable; /* Active/Bootable flag is set */
  49. #ifdef CONFIG_PARTITION_UUIDS
  50. char uuid[37]; /* filesystem UUID as string, if exists */
  51. #endif
  52. #ifdef CONFIG_PARTITION_TYPE_GUID
  53. char type_guid[37]; /* type GUID as string, if exists */
  54. #endif
  55. } disk_partition_t;
  56. /* Misc _get_dev functions */
  57. #ifdef CONFIG_PARTITIONS
  58. /**
  59. * blk_get_dev() - get a pointer to a block device given its type and number
  60. *
  61. * Each interface allocates its own devices and typically struct blk_desc is
  62. * contained with the interface's data structure. There is no global
  63. * numbering for block devices, so the interface name must be provided.
  64. *
  65. * @ifname: Interface name (e.g. "ide", "scsi")
  66. * @dev: Device number (0 for first device on that interface, 1 for
  67. * second, etc.
  68. * @return pointer to the block device, or NULL if not available, or an
  69. * error occurred.
  70. */
  71. struct blk_desc *blk_get_dev(const char *ifname, int dev);
  72. struct blk_desc *mg_disk_get_dev(int dev);
  73. int host_get_dev_err(int dev, struct blk_desc **blk_devp);
  74. /* disk/part.c */
  75. int part_get_info(struct blk_desc *dev_desc, int part, disk_partition_t *info);
  76. void part_print(struct blk_desc *dev_desc);
  77. void part_init(struct blk_desc *dev_desc);
  78. void dev_print(struct blk_desc *dev_desc);
  79. /**
  80. * blk_get_device_by_str() - Get a block device given its interface/hw partition
  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. * The hardware parition is not related to the normal software partitioning
  87. * of a device - each hardware partition is effectively a separately
  88. * accessible block device. When a hardware parition is selected on MMC the
  89. * other hardware partitions become inaccessible. The same block device is
  90. * used to access all hardware partitions, but its capacity may change when a
  91. * different hardware partition is selected.
  92. *
  93. * When a hardware partition number is given, the block device switches to
  94. * that hardware partition.
  95. *
  96. * @ifname: Interface name (e.g. "ide", "scsi")
  97. * @dev_str: Device and optional hw partition. This can either be a string
  98. * containing the device number (e.g. "2") or the device number
  99. * and hardware partition number (e.g. "2.4") for devices that
  100. * support it (currently only MMC).
  101. * @dev_desc: Returns a pointer to the block device on success
  102. * @return block device number (local to the interface), or -1 on error
  103. */
  104. int blk_get_device_by_str(const char *ifname, const char *dev_str,
  105. struct blk_desc **dev_desc);
  106. /**
  107. * blk_get_device_part_str() - Get a block device and partition
  108. *
  109. * This calls blk_get_device_by_str() to look up a device. It also looks up
  110. * a partition and returns information about it.
  111. *
  112. * @dev_part_str is in the format:
  113. * <dev>.<hw_part>:<part> where <dev> is the device number,
  114. * <hw_part> is the optional hardware partition number and
  115. * <part> is the partition number
  116. *
  117. * If ifname is "hostfs" then this function returns the sandbox host block
  118. * device.
  119. *
  120. * If ifname is ubi, then this function returns 0, with @info set to a
  121. * special UBI device.
  122. *
  123. * If @dev_part_str is NULL or empty or "-", then this function looks up
  124. * the "bootdevice" environment variable and uses that string instead.
  125. *
  126. * If the partition string is empty then the first partition is used. If the
  127. * partition string is "auto" then the first bootable partition is used.
  128. *
  129. * @ifname: Interface name (e.g. "ide", "scsi")
  130. * @dev_part_str: Device and partition string
  131. * @dev_desc: Returns a pointer to the block device on success
  132. * @info: Returns partition information
  133. * @allow_whole_dev: true to allow the user to select partition 0
  134. * (which means the whole device), false to require a valid
  135. * partition number >= 1
  136. * @return partition number, or -1 on error
  137. *
  138. */
  139. int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
  140. struct blk_desc **dev_desc,
  141. disk_partition_t *info, int allow_whole_dev);
  142. /**
  143. * part_get_info_by_name() - Search for a partition by name
  144. * among all available registered partitions
  145. *
  146. * @param dev_desc - block device descriptor
  147. * @param gpt_name - the specified table entry name
  148. * @param info - returns the disk partition info
  149. *
  150. * @return - '0' on match, '-1' on no match, otherwise error
  151. */
  152. int part_get_info_by_name(struct blk_desc *dev_desc,
  153. const char *name, disk_partition_t *info);
  154. extern const struct block_drvr block_drvr[];
  155. #else
  156. static inline struct blk_desc *blk_get_dev(const char *ifname, int dev)
  157. { return NULL; }
  158. static inline struct blk_desc *mg_disk_get_dev(int dev) { return NULL; }
  159. static inline int part_get_info(struct blk_desc *dev_desc, int part,
  160. disk_partition_t *info) { return -1; }
  161. static inline void part_print(struct blk_desc *dev_desc) {}
  162. static inline void part_init(struct blk_desc *dev_desc) {}
  163. static inline void dev_print(struct blk_desc *dev_desc) {}
  164. static inline int blk_get_device_by_str(const char *ifname, const char *dev_str,
  165. struct blk_desc **dev_desc)
  166. { return -1; }
  167. static inline int blk_get_device_part_str(const char *ifname,
  168. const char *dev_part_str,
  169. struct blk_desc **dev_desc,
  170. disk_partition_t *info,
  171. int allow_whole_dev)
  172. { *dev_desc = NULL; return -1; }
  173. #endif
  174. /*
  175. * We don't support printing partition information in SPL and only support
  176. * getting partition information in a few cases.
  177. */
  178. #ifdef CONFIG_SPL_BUILD
  179. # define part_print_ptr(x) NULL
  180. # if defined(CONFIG_SPL_EXT_SUPPORT) || defined(CONFIG_SPL_FAT_SUPPORT) || \
  181. defined(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION)
  182. # define part_get_info_ptr(x) x
  183. # else
  184. # define part_get_info_ptr(x) NULL
  185. # endif
  186. #else
  187. #define part_print_ptr(x) x
  188. #define part_get_info_ptr(x) x
  189. #endif
  190. struct part_driver {
  191. const char *name;
  192. int part_type;
  193. const int max_entries; /* maximum number of entries to search */
  194. /**
  195. * get_info() - Get information about a partition
  196. *
  197. * @dev_desc: Block device descriptor
  198. * @part: Partition number (1 = first)
  199. * @info: Returns partition information
  200. */
  201. int (*get_info)(struct blk_desc *dev_desc, int part,
  202. disk_partition_t *info);
  203. /**
  204. * print() - Print partition information
  205. *
  206. * @dev_desc: Block device descriptor
  207. */
  208. void (*print)(struct blk_desc *dev_desc);
  209. /**
  210. * test() - Test if a device contains this partition type
  211. *
  212. * @dev_desc: Block device descriptor
  213. * @return 0 if the block device appears to contain this partition
  214. * type, -ve if not
  215. */
  216. int (*test)(struct blk_desc *dev_desc);
  217. };
  218. /* Declare a new U-Boot partition 'driver' */
  219. #define U_BOOT_PART_TYPE(__name) \
  220. ll_entry_declare(struct part_driver, __name, part_driver)
  221. #ifdef CONFIG_EFI_PARTITION
  222. #include <part_efi.h>
  223. /* disk/part_efi.c */
  224. /**
  225. * write_gpt_table() - Write the GUID Partition Table to disk
  226. *
  227. * @param dev_desc - block device descriptor
  228. * @param gpt_h - pointer to GPT header representation
  229. * @param gpt_e - pointer to GPT partition table entries
  230. *
  231. * @return - zero on success, otherwise error
  232. */
  233. int write_gpt_table(struct blk_desc *dev_desc,
  234. gpt_header *gpt_h, gpt_entry *gpt_e);
  235. /**
  236. * gpt_fill_pte(): Fill the GPT partition table entry
  237. *
  238. * @param gpt_h - GPT header representation
  239. * @param gpt_e - GPT partition table entries
  240. * @param partitions - list of partitions
  241. * @param parts - number of partitions
  242. *
  243. * @return zero on success
  244. */
  245. int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
  246. disk_partition_t *partitions, int parts);
  247. /**
  248. * gpt_fill_header(): Fill the GPT header
  249. *
  250. * @param dev_desc - block device descriptor
  251. * @param gpt_h - GPT header representation
  252. * @param str_guid - disk guid string representation
  253. * @param parts_count - number of partitions
  254. *
  255. * @return - error on str_guid conversion error
  256. */
  257. int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
  258. char *str_guid, int parts_count);
  259. /**
  260. * gpt_restore(): Restore GPT partition table
  261. *
  262. * @param dev_desc - block device descriptor
  263. * @param str_disk_guid - disk GUID
  264. * @param partitions - list of partitions
  265. * @param parts - number of partitions
  266. *
  267. * @return zero on success
  268. */
  269. int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
  270. disk_partition_t *partitions, const int parts_count);
  271. /**
  272. * is_valid_gpt_buf() - Ensure that the Primary GPT information is valid
  273. *
  274. * @param dev_desc - block device descriptor
  275. * @param buf - buffer which contains the MBR and Primary GPT info
  276. *
  277. * @return - '0' on success, otherwise error
  278. */
  279. int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
  280. /**
  281. * write_mbr_and_gpt_partitions() - write MBR, Primary GPT and Backup GPT
  282. *
  283. * @param dev_desc - block device descriptor
  284. * @param buf - buffer which contains the MBR and Primary GPT info
  285. *
  286. * @return - '0' on success, otherwise error
  287. */
  288. int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
  289. /**
  290. * gpt_verify_headers() - Function to read and CRC32 check of the GPT's header
  291. * and partition table entries (PTE)
  292. *
  293. * As a side effect if sets gpt_head and gpt_pte so they point to GPT data.
  294. *
  295. * @param dev_desc - block device descriptor
  296. * @param gpt_head - pointer to GPT header data read from medium
  297. * @param gpt_pte - pointer to GPT partition table enties read from medium
  298. *
  299. * @return - '0' on success, otherwise error
  300. */
  301. int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
  302. gpt_entry **gpt_pte);
  303. /**
  304. * gpt_verify_partitions() - Function to check if partitions' name, start and
  305. * size correspond to '$partitions' env variable
  306. *
  307. * This function checks if on medium stored GPT data is in sync with information
  308. * provided in '$partitions' environment variable. Specificially, name, start
  309. * and size of the partition is checked.
  310. *
  311. * @param dev_desc - block device descriptor
  312. * @param partitions - partition data read from '$partitions' env variable
  313. * @param parts - number of partitions read from '$partitions' env variable
  314. * @param gpt_head - pointer to GPT header data read from medium
  315. * @param gpt_pte - pointer to GPT partition table enties read from medium
  316. *
  317. * @return - '0' on success, otherwise error
  318. */
  319. int gpt_verify_partitions(struct blk_desc *dev_desc,
  320. disk_partition_t *partitions, int parts,
  321. gpt_header *gpt_head, gpt_entry **gpt_pte);
  322. #endif
  323. #endif /* _PART_H */