flashdisk.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007 Chris Johns
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rtems.org/license/LICENSE.
 */

#if !defined (_RTEMS_FLASHDISK_H_)
#define _RTEMS_FLASHDISK_H_

#include <stdint.h>
#include <sys/ioctl.h>

#include <rtems.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define RTEMS_FLASHDISK_DEVICE_BASE_NAME "/dev/fdd"

#define RTEMS_FDISK_IOCTL_ERASE_DISK   _IO('B', 128)
#define RTEMS_FDISK_IOCTL_COMPACT      _IO('B', 129)
#define RTEMS_FDISK_IOCTL_ERASE_USED   _IO('B', 130)
#define RTEMS_FDISK_IOCTL_MONITORING   _IO('B', 131)
#define RTEMS_FDISK_IOCTL_INFO_LEVEL   _IO('B', 132)
#define RTEMS_FDISK_IOCTL_PRINT_STATUS _IO('B', 133)

typedef struct rtems_fdisk_monitor_data
{
  uint32_t block_size;
  uint32_t block_count;
  uint32_t unavail_blocks;
  uint32_t device_count;
  uint32_t segment_count;
  uint32_t page_count;
  uint32_t blocks_used;
  uint32_t segs_available;
  uint32_t segs_used;
  uint32_t segs_failed;
  uint32_t seg_erases;
  uint32_t pages_desc;
  uint32_t pages_active;
  uint32_t pages_used;
  uint32_t pages_bad;
  uint32_t info_level;
} rtems_fdisk_monitor_data;

typedef struct rtems_fdisk_segment_desc
{
  uint16_t count;    
  uint16_t segment;  
  uint32_t offset;   
  uint32_t size;     
} rtems_fdisk_segment_desc;

#define RTEMS_FDISK_KBYTES(_k) (UINT32_C(1024) * (_k))

struct rtems_fdisk_device_desc;

typedef struct rtems_fdisk_driver_handlers
{
  int (*read) (const rtems_fdisk_segment_desc* sd,
               uint32_t                        device,
               uint32_t                        segment,
               uint32_t                        offset,
               void*                           buffer,
               uint32_t                        size);

  int (*write) (const rtems_fdisk_segment_desc* sd,
                uint32_t                        device,
                uint32_t                        segment,
                uint32_t                        offset,
                const void*                     buffer,
                uint32_t                        size);

  int (*blank) (const rtems_fdisk_segment_desc* sd,
                uint32_t                        device,
                uint32_t                        segment,
                uint32_t                        offset,
                uint32_t                        size);

  int (*verify) (const rtems_fdisk_segment_desc* sd,
                 uint32_t                        device,
                 uint32_t                        segment,
                 uint32_t                        offset,
                 const void*                     buffer,
                 uint32_t                        size);

  int (*erase) (const rtems_fdisk_segment_desc* sd,
                uint32_t                        device,
                uint32_t                        segment);

  int (*erase_device) (const struct rtems_fdisk_device_desc* dd,
                       uint32_t                              device);

} rtems_fdisk_driver_handlers;

typedef struct rtems_fdisk_device_desc
{
  uint32_t                           segment_count; 
  const rtems_fdisk_segment_desc*    segments;      
  const rtems_fdisk_driver_handlers* flash_ops;     
} rtems_fdisk_device_desc;

typedef struct rtems_flashdisk_config
{
  uint32_t                       block_size;     
  uint32_t                       device_count;   
  const rtems_fdisk_device_desc* devices;        
  uint32_t                       flags;          
  uint32_t                       unavail_blocks;

  uint32_t                       compact_segs;   
  uint32_t                       avail_compact_segs;
  uint32_t                       info_level;     
} rtems_flashdisk_config;

/*
 * Driver flags.
 */

#define RTEMS_FDISK_BACKGROUND_ERASE (1 << 0)

#define RTEMS_FDISK_BACKGROUND_COMPACT (1 << 1)

#define RTEMS_FDISK_CHECK_PAGES (1 << 2)

#define RTEMS_FDISK_BLANK_CHECK_BEFORE_WRITE (1 << 3)

rtems_device_driver
rtems_fdisk_initialize (rtems_device_major_number major,
                        rtems_device_minor_number minor,
                        void*                     arg);

extern const rtems_flashdisk_config rtems_flashdisk_configuration[];

extern uint32_t rtems_flashdisk_configuration_size;

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif