PartInfo.h

Go to the documentation of this file.

/****
 * PartInfo.h
 *
 * Copyright 2022 mikee47 <mike@sillyhouse.net>
 *
 * This file is part of the DiskStorage Library
 *
 * This library is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, version 3 or later.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this library.
 * If not, see <https://www.gnu.org/licenses/>.
 *
 ****/
 
#pragma once
 
#include <Storage/Partition.h>
#include <Data/Uuid.h>
#include "Error.h"
 
namespace Storage::Disk
{
/*
 * While not a native feature of file systems, operating systems should also aim to align partitions correctly,
 * which avoids excessive read-modify-write cycles.
 * A typical practice for personal computers is to have each partition aligned to start at a 1 MiB (= 1,048,576 bytes) mark,
 * which covers all common SSD page and block size scenarios, as it is divisible by all commonly used sizes
 * - 1 MiB, 512 KiB, 128 KiB, 4 KiB, and 512 B.
 */
constexpr uint32_t PARTITION_ALIGN{0x100000U};
 
enum class SysType : uint8_t {
    unknown, 
    fat12,
    fat16,
    fat32,
    exfat,
};
 
using SysTypes = BitSet<uint8_t, SysType>;
 
static constexpr SysTypes fatTypes = SysType::fat12 | SysType::fat16 | SysType::fat32 | SysType::exfat;
 
enum SysIndicator {
    SI_FAT12 = 0x01,
    SI_FAT16 = 0x04,  
    SI_FAT16B = 0x06, 
    SI_IFS = 0x07,
    SI_EXFAT = 0x07,
    SI_FAT32X = 0x0c, 
};
 
inline SysType getSysTypeFromIndicator(SysIndicator si)
{
    switch(si) {
    case SI_FAT12:
        return SysType::fat12;
    case SI_FAT16:
    case SI_FAT16B:
        return SysType::fat16;
    case SI_FAT32X:
        return SysType::fat32;
    case SI_EXFAT:
        return SysType::exfat;
    default:
        return SysType::unknown;
    }
}
 
struct DiskPart {
    Uuid typeGuid;         
    Uuid uniqueGuid;       
    SysType systype{};   
    SysIndicator sysind{}; 
 
    size_t printTo(Print& p) const;
};
 
struct PartInfo : public Partition::Info, public DiskPart {
    using OwnedList = OwnedLinkedObjectListTemplate<PartInfo>;
 
    template <typename... Args> PartInfo(Args... args) : Partition::Info(args...)
    {
    }
 
    const Disk::DiskPart* diskpart() const override
    {
        return this;
    }
 
    size_t printTo(Print& p) const override;
};
 
class BasePartitionTable : public PartInfo::OwnedList
{
};
 
Error validate(BasePartitionTable& table, storage_size_t firstAvailableBlock, storage_size_t totalAvailableBlocks,
               uint32_t blockSize);
 
} // namespace Storage::Disk
 
String toString(Storage::Disk::SysType type);