Skip to content

Commit b2eaaaa

Browse files
committed
Documentation update about MBRBlockDevice::partition type parameter
1 parent 9a8c9e2 commit b2eaaaa

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

features/storage/blockdevice/MBRBlockDevice.h

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,21 +52,25 @@ class MBRBlockDevice : public BlockDevice {
5252
*
5353
* @param bd Block device to partition
5454
* @param part Partition to use, 1-4
55-
* @param type 8-bit partition type to identify partition contents
55+
* @param type 8-bit partition type or ID to identify partition contents
5656
* @param start Start block address to map to block 0 of partition.
5757
* Negative addresses are calculated from the end of the
5858
* underlying block devices. Block 0 is implicitly ignored
5959
* from the range to store the MBR.
6060
* @return 0 on success or a negative error code on failure.
6161
* @note This is the same as partition(bd, part, type, start, bd->size())
62+
* @note 8-bit partition type or ID is intended to specify the filesystem partition
63+
* contains and/or to flag special access methods used to access these partitions
64+
* for example like CHS mapping, LBA access etc.,
65+
* The list of Partition types or IDS refer https://en.wikipedia.org/wiki/Partition_type#List_of_partition_IDs
6266
*/
6367
static int partition(BlockDevice *bd, int part, uint8_t type, bd_addr_t start);
6468

6569
/** Format the MBR to contain the following partition
6670
*
6771
* @param bd Block device to partition
6872
* @param part Partition to use, 1-4
69-
* @param type 8-bit partition type to identify partition contents
73+
* @param type 8-bit partition type or ID to identify partition contents
7074
* @param start Start block address to map to block 0 of partition,
7175
* negative addresses are calculated from the end of the
7276
* underlying block devices. Block 0 is implicitly ignored
@@ -193,8 +197,8 @@ class MBRBlockDevice : public BlockDevice {
193197
*/
194198
virtual bd_addr_t get_partition_stop() const;
195199

196-
/** Get 8-bit type of the partition
197-
* @return 8-bit type of partition assigned during format
200+
/** Get 8-bit type or ID of the partition
201+
* @return 8-bit type or ID of partition assigned during format
198202
*/
199203
virtual uint8_t get_partition_type() const;
200204

0 commit comments

Comments
 (0)