nvdisk.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_NVDISK_H_)
#define _RTEMS_NVDISK_H_

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

#include <rtems.h>

#define RTEMS_NVDISK_DEVICE_BASE_NAME "/dev/nvd"

#define RTEMS_NVDISK_IOCTL_ERASE_DISK   _IO('B', 128)
#define RTEMS_NVDISK_IOCTL_MONITORING   _IO('B', 129)
#define RTEMS_NVDISK_IOCTL_INFO_LEVEL   _IO('B', 130)
#define RTEMS_NVDISK_IOCTL_PRINT_STATUS _IO('B', 131)

typedef struct rtems_nvdisk_monitor_data
{
  uint32_t block_size;
  uint32_t block_count;
  uint32_t page_count;
  uint32_t pages_available;
  uint32_t pages_used;
  uint32_t info_level;
} rtems_nvdisk_monitor_data;

#define RTEMS_NVDISK_KBYTES(_k) ((_k) * 1024)

typedef struct rtems_nvdisk_driver_handlers
{
  int (*read) (uint32_t device, uint32_t flags, void* base,
               uint32_t offset, void* buffer, size_t size);

  int (*write) (uint32_t device, uint32_t flags, void* base,
                uint32_t offset, const void* buffer, size_t size);

  int (*verify) (uint32_t device, uint32_t flags, void* base,
                 uint32_t offset, const void* buffer, size_t size);

} rtems_nvdisk_driver_handlers;

typedef struct rtems_nvdisk_device_desc
{
  uint32_t                            flags;  
  void*                               base;   
  uint32_t                            size;   
  const rtems_nvdisk_driver_handlers* nv_ops; 
} rtems_nvdisk_device_desc;

typedef struct rtems_nvdisk_config
{
  uint32_t                        block_size;   
  uint32_t                        device_count; 
  const rtems_nvdisk_device_desc* devices;      
  uint32_t                        flags;        
  uint32_t                        info_level;   
} rtems_nvdisk_config;

/*
 * Driver flags.
 */

#define RTEMS_NVDISK_CHECK_PAGES (1 << 0)

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

extern const rtems_nvdisk_config rtems_nvdisk_configuration[];

extern uint32_t rtems_nvdisk_configuration_size;

#endif