1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
//! # embedded-sdmmc
//!
//! > An SD/MMC Library written in Embedded Rust
//!
//! This crate is intended to allow you to read/write files on a FAT formatted
//! SD card on your Rust Embedded device, as easily as using the `SdFat` Arduino
//! library. It is written in pure-Rust, is `#![no_std]` and does not use
//! `alloc` or `collections` to keep the memory footprint low. In the first
//! instance it is designed for readability and simplicity over performance.
//!
//! ## Using the crate
//!
//! You will need something that implements the `BlockDevice` trait, which can
//! read and write the 512-byte blocks (or sectors) from your card. If you were
//! to implement this over USB Mass Storage, there's no reason this crate
//! couldn't work with a USB Thumb Drive, but we only supply a `BlockDevice`
//! suitable for reading SD and SDHC cards over SPI.
//!
//! ```rust
//! use embedded_sdmmc::{Error, Mode, SdCard, SdCardError, TimeSource, VolumeIdx, VolumeManager};
//!
//! fn example<S, CS, D, T>(spi: S, cs: CS, delay: D, ts: T) -> Result<(), Error<SdCardError>>
//! where
//! S: embedded_hal::spi::SpiDevice,
//! CS: embedded_hal::digital::OutputPin,
//! D: embedded_hal::delay::DelayNs,
//! T: TimeSource,
//! {
//! let sdcard = SdCard::new(spi, cs, delay);
//! println!("Card size is {} bytes", sdcard.num_bytes()?);
//! let mut volume_mgr = VolumeManager::new(sdcard, ts);
//! let mut volume0 = volume_mgr.open_volume(VolumeIdx(0))?;
//! println!("Volume 0: {:?}", volume0);
//! let mut root_dir = volume0.open_root_dir()?;
//! let mut my_file = root_dir.open_file_in_dir("MY_FILE.TXT", Mode::ReadOnly)?;
//! while !my_file.is_eof() {
//! let mut buffer = [0u8; 32];
//! let num_read = my_file.read(&mut buffer)?;
//! for b in &buffer[0..num_read] {
//! print!("{}", *b as char);
//! }
//! }
//! Ok(())
//! }
//! ```
//!
//! ## Features
//!
//! * `log`: Enabled by default. Generates log messages using the `log` crate.
//! * `defmt-log`: By turning off the default features and enabling the
//! `defmt-log` feature you can configure this crate to log messages over defmt
//! instead.
//!
//! You cannot enable both the `log` feature and the `defmt-log` feature.
#![cfg_attr(not(test), no_std)]
#![deny(missing_docs)]
// ****************************************************************************
//
// Imports
//
// ****************************************************************************
#[cfg(test)]
#[macro_use]
extern crate hex_literal;
#[macro_use]
mod structure;
pub mod blockdevice;
pub mod fat;
pub mod filesystem;
pub mod sdcard;
use filesystem::SearchId;
#[doc(inline)]
pub use crate::blockdevice::{Block, BlockCount, BlockDevice, BlockIdx};
#[doc(inline)]
pub use crate::fat::FatVolume;
#[doc(inline)]
pub use crate::filesystem::{
Attributes, ClusterId, DirEntry, Directory, File, FilenameError, Mode, RawDirectory, RawFile,
ShortFileName, TimeSource, Timestamp, MAX_FILE_SIZE,
};
use filesystem::DirectoryInfo;
#[doc(inline)]
pub use crate::sdcard::Error as SdCardError;
#[doc(inline)]
pub use crate::sdcard::SdCard;
mod volume_mgr;
#[doc(inline)]
pub use volume_mgr::VolumeManager;
#[cfg(all(feature = "defmt-log", feature = "log"))]
compile_error!("Cannot enable both log and defmt-log");
#[cfg(feature = "log")]
use log::{debug, trace, warn};
#[cfg(feature = "defmt-log")]
use defmt::{debug, trace, warn};
#[cfg(all(not(feature = "defmt-log"), not(feature = "log")))]
#[macro_export]
/// Like log::debug! but does nothing at all
macro_rules! debug {
($($arg:tt)+) => {};
}
#[cfg(all(not(feature = "defmt-log"), not(feature = "log")))]
#[macro_export]
/// Like log::trace! but does nothing at all
macro_rules! trace {
($($arg:tt)+) => {};
}
#[cfg(all(not(feature = "defmt-log"), not(feature = "log")))]
#[macro_export]
/// Like log::warn! but does nothing at all
macro_rules! warn {
($($arg:tt)+) => {};
}
// ****************************************************************************
//
// Public Types
//
// ****************************************************************************
/// Represents all the ways the functions in this crate can fail.
#[cfg_attr(feature = "defmt-log", derive(defmt::Format))]
#[derive(Debug, Clone)]
pub enum Error<E>
where
E: core::fmt::Debug,
{
/// The underlying block device threw an error.
DeviceError(E),
/// The filesystem is badly formatted (or this code is buggy).
FormatError(&'static str),
/// The given `VolumeIdx` was bad,
NoSuchVolume,
/// The given filename was bad
FilenameError(FilenameError),
/// Out of memory opening volumes
TooManyOpenVolumes,
/// Out of memory opening directories
TooManyOpenDirs,
/// Out of memory opening files
TooManyOpenFiles,
/// Bad handle given
BadHandle,
/// That file or directory doesn't exist
NotFound,
/// You can't open a file twice or delete an open file
FileAlreadyOpen,
/// You can't open a directory twice
DirAlreadyOpen,
/// You can't open a directory as a file
OpenedDirAsFile,
/// You can't open a file as a directory
OpenedFileAsDir,
/// You can't delete a directory as a file
DeleteDirAsFile,
/// You can't close a volume with open files or directories
VolumeStillInUse,
/// You can't open a volume twice
VolumeAlreadyOpen,
/// We can't do that yet
Unsupported,
/// Tried to read beyond end of file
EndOfFile,
/// Found a bad cluster
BadCluster,
/// Error while converting types
ConversionError,
/// The device does not have enough space for the operation
NotEnoughSpace,
/// Cluster was not properly allocated by the library
AllocationError,
/// Jumped to free space during FAT traversing
UnterminatedFatChain,
/// Tried to open Read-Only file with write mode
ReadOnly,
/// Tried to create an existing file
FileAlreadyExists,
/// Bad block size - only 512 byte blocks supported
BadBlockSize(u16),
/// Bad offset given when seeking
InvalidOffset,
/// Disk is full
DiskFull,
/// A directory with that name already exists
DirAlreadyExists,
}
impl<E> From<E> for Error<E>
where
E: core::fmt::Debug,
{
fn from(value: E) -> Error<E> {
Error::DeviceError(value)
}
}
/// Represents a partition with a filesystem within it.
#[cfg_attr(feature = "defmt-log", derive(defmt::Format))]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct RawVolume(SearchId);
impl RawVolume {
/// Convert a raw volume into a droppable [`Volume`]
pub fn to_volume<
D,
T,
const MAX_DIRS: usize,
const MAX_FILES: usize,
const MAX_VOLUMES: usize,
>(
self,
volume_mgr: &mut VolumeManager<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>,
) -> Volume<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>
where
D: crate::BlockDevice,
T: crate::TimeSource,
{
Volume::new(self, volume_mgr)
}
}
/// Represents an open volume on disk.
///
/// If you drop a value of this type, it closes the volume automatically. However,
/// it holds a mutable reference to its parent `VolumeManager`, which restricts
/// which operations you can perform.
pub struct Volume<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize>
where
D: crate::BlockDevice,
T: crate::TimeSource,
{
raw_volume: RawVolume,
volume_mgr: &'a mut VolumeManager<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>,
}
impl<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize>
Volume<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>
where
D: crate::BlockDevice,
T: crate::TimeSource,
{
/// Create a new `Volume` from a `RawVolume`
pub fn new(
raw_volume: RawVolume,
volume_mgr: &'a mut VolumeManager<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>,
) -> Volume<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES> {
Volume {
raw_volume,
volume_mgr,
}
}
/// Open the volume's root directory.
///
/// You can then read the directory entries with `iterate_dir`, or you can
/// use `open_file_in_dir`.
pub fn open_root_dir(
&mut self,
) -> Result<crate::Directory<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>, Error<D::Error>> {
let d = self.volume_mgr.open_root_dir(self.raw_volume)?;
Ok(d.to_directory(self.volume_mgr))
}
/// Convert back to a raw volume
pub fn to_raw_volume(self) -> RawVolume {
let v = self.raw_volume;
core::mem::forget(self);
v
}
}
impl<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> Drop
for Volume<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>
where
D: crate::BlockDevice,
T: crate::TimeSource,
{
fn drop(&mut self) {
self.volume_mgr
.close_volume(self.raw_volume)
.expect("Failed to close volume");
}
}
impl<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize>
core::fmt::Debug for Volume<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>
where
D: crate::BlockDevice,
T: crate::TimeSource,
{
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "Volume({})", self.raw_volume.0 .0)
}
}
#[cfg(feature = "defmt-log")]
impl<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize>
defmt::Format for Volume<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>
where
D: crate::BlockDevice,
T: crate::TimeSource,
{
fn format(&self, fmt: defmt::Formatter) {
defmt::write!(fmt, "Volume({})", self.raw_volume.0 .0)
}
}
/// Internal information about a Volume
#[cfg_attr(feature = "defmt-log", derive(defmt::Format))]
#[derive(Debug, PartialEq, Eq)]
pub(crate) struct VolumeInfo {
/// Search ID for this volume.
volume_id: RawVolume,
/// TODO: some kind of index
idx: VolumeIdx,
/// What kind of volume this is
volume_type: VolumeType,
}
/// This enum holds the data for the various different types of filesystems we
/// support.
#[cfg_attr(feature = "defmt-log", derive(defmt::Format))]
#[derive(Debug, PartialEq, Eq)]
pub enum VolumeType {
/// FAT16/FAT32 formatted volumes.
Fat(FatVolume),
}
/// A `VolumeIdx` is a number which identifies a volume (or partition) on a
/// disk.
///
/// `VolumeIdx(0)` is the first primary partition on an MBR partitioned disk.
#[cfg_attr(feature = "defmt-log", derive(defmt::Format))]
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub struct VolumeIdx(pub usize);
/// Marker for a FAT32 partition. Sometimes also use for FAT16 formatted
/// partitions.
const PARTITION_ID_FAT32_LBA: u8 = 0x0C;
/// Marker for a FAT16 partition with LBA. Seen on a Raspberry Pi SD card.
const PARTITION_ID_FAT16_LBA: u8 = 0x0E;
/// Marker for a FAT16 partition. Seen on a card formatted with the official
/// SD-Card formatter.
const PARTITION_ID_FAT16: u8 = 0x06;
/// Marker for a FAT32 partition. What Macosx disk utility (and also SD-Card formatter?)
/// use.
const PARTITION_ID_FAT32_CHS_LBA: u8 = 0x0B;
// ****************************************************************************
//
// Unit Tests
//
// ****************************************************************************
// None
// ****************************************************************************
//
// End Of File
//
// ****************************************************************************