nvdisk.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

 
/*
 * Copyright (C) 2007 Chris Johns
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#if !defined (_RTEMS_NVDISK_H_)
#define _RTEMS_NVDISK_H_
 
#include <stdint.h>
#include <sys/ioctl.h>
 
#include <rtems.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#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;
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif