Nut/OS  5.0.5
API Reference
Data Fields
_BLOCKVOLUME Struct Reference

Block volume information structure. More...

Collaboration diagram for _BLOCKVOLUME:
[legend]

Data Fields

NUTDEVICE * vol_fsdev
 Attached file system device.
uint32_t vol_blk_cnt
 Number of blocks available to the file system.
int vol_blk_len
 Number of bytes in a block.
uint32_t vol_blk_off
 First page used by the file system.
uint32_t vol_blk_num
 Next block number to read.
uint8_t * vol_blk_buf
 Internal block buffer.

Detailed Description

Block volume information structure.

Field Documentation

NUTDEVICE* _BLOCKVOLUME::vol_fsdev

Attached file system device.

Referenced by NutBlockDeviceClose(), and NutBlockDeviceOpen().

uint32_t _BLOCKVOLUME::vol_blk_cnt

Number of blocks available to the file system.

Referenced by NutBlockDeviceIOCtl(), NutBlockDeviceOpen(), NutBlockDeviceRead(), NutBlockDeviceSize(), NutBlockDeviceWrite(), and NutBlockDeviceWrite_P().

int _BLOCKVOLUME::vol_blk_len

Number of bytes in a block.

Referenced by NutBlockDeviceIOCtl(), NutBlockDeviceOpen(), NutBlockDeviceRead(), NutBlockDeviceSize(), NutBlockDeviceWrite(), and NutBlockDeviceWrite_P().

uint32_t _BLOCKVOLUME::vol_blk_off

First page used by the file system.

Referenced by NutBlockDeviceOpen(), NutBlockDeviceRead(), NutBlockDeviceWrite(), and NutBlockDeviceWrite_P().

uint32_t _BLOCKVOLUME::vol_blk_num

Next block number to read.

The file system driver will send a NUTBLKDEV_SEEK control command to set this value before calling the read or the write routine.

The number is zero based.

Referenced by NutBlockDeviceIOCtl(), NutBlockDeviceOpen(), NutBlockDeviceRead(), NutBlockDeviceWrite(), and NutBlockDeviceWrite_P().

uint8_t* _BLOCKVOLUME::vol_blk_buf

Internal block buffer.

A file system driver may use this one or optionally provide it's own buffers.

Minimal systems may share their external bus interface with device I/O lines, in which case the buffer must be located in internal memory.

Referenced by NutBlockDeviceIOCtl(), and NutBlockDeviceOpen().

The documentation for this struct was generated from the following file: