diskdevs.h

Go to the documentation of this file.

/*
 * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
 * Author: Victor V. Vengerov <vvv@oktet.ru>
 */

#ifndef _RTEMS_DISKDEVS_H
#define _RTEMS_DISKDEVS_H

#include <rtems.h>
#include <rtems/libio.h>
#include <rtems/chain.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct rtems_disk_device rtems_disk_device;

typedef uint32_t rtems_blkdev_bnum;

typedef int (*rtems_block_device_ioctl)(
  rtems_disk_device *dd,
  uint32_t req,
  void *argp
);

#define RTEMS_DISK_READ_AHEAD_NO_TRIGGER ((rtems_blkdev_bnum) -1)

typedef struct {
  rtems_chain_node node;

  rtems_blkdev_bnum trigger;

  rtems_blkdev_bnum next;
} rtems_blkdev_read_ahead;

typedef struct {
  uint32_t read_hits;

  uint32_t read_misses;

  uint32_t read_ahead_transfers;

  uint32_t read_blocks;

  uint32_t read_errors;

  uint32_t write_transfers;

  uint32_t write_blocks;

  uint32_t write_errors;
} rtems_blkdev_stats;

struct rtems_disk_device {
  dev_t dev;

  rtems_disk_device *phys_dev;

  uint32_t capabilities;

  char *name;

  unsigned uses;

  rtems_blkdev_bnum start;

  rtems_blkdev_bnum size;

  uint32_t media_block_size;

  uint32_t block_size;

  rtems_blkdev_bnum block_count;

  uint32_t media_blocks_per_block;

  int block_to_media_block_shift;

  size_t bds_per_group;

  rtems_block_device_ioctl ioctl;

  void *driver_data;

  bool deleted;

  rtems_blkdev_stats stats;

  rtems_blkdev_read_ahead read_ahead;
};

/* Use fstat() instead */
RTEMS_DEPRECATED static inline dev_t rtems_disk_get_device_identifier(
  const rtems_disk_device *dd
)
{
  return dd->dev;
}

/* Use fstat() instead */
RTEMS_DEPRECATED static inline rtems_device_major_number rtems_disk_get_major_number(
  const rtems_disk_device *dd
)
{
  return rtems_filesystem_dev_major_t(dd->dev);
}

/* Use fstat() instead */
RTEMS_DEPRECATED static inline rtems_device_minor_number rtems_disk_get_minor_number(
  const rtems_disk_device *dd
)
{
  return rtems_filesystem_dev_minor_t(dd->dev);
}

static inline void *rtems_disk_get_driver_data(
  const rtems_disk_device *dd
)
{
  return dd->driver_data;
}

static inline uint32_t rtems_disk_get_media_block_size(
  const rtems_disk_device *dd
)
{
  return dd->media_block_size;
}

static inline uint32_t rtems_disk_get_block_size(
  const rtems_disk_device *dd
)
{
  return dd->block_size;
}

static inline rtems_blkdev_bnum rtems_disk_get_block_begin(
  const rtems_disk_device *dd
)
{
  return dd->start;
}

static inline rtems_blkdev_bnum rtems_disk_get_block_count(
  const rtems_disk_device *dd
)
{
  return dd->size;
}

/* Use rtems_blkdev_create() instead */
RTEMS_DEPRECATED rtems_status_code rtems_disk_create_phys(
  dev_t dev,
  uint32_t block_size,
  rtems_blkdev_bnum block_count,
  rtems_block_device_ioctl handler,
  void *driver_data,
  const char *name
);

/* Use rtems_blkdev_create_partition() instead */
RTEMS_DEPRECATED rtems_status_code rtems_disk_create_log(
  dev_t dev,
  dev_t phys,
  rtems_blkdev_bnum block_begin,
  rtems_blkdev_bnum block_count,
  const char *name
);

/*
 * Use rtems_blkdev_create() or rtems_blkdev_create_partition and unlink()
 * instead.
 */
RTEMS_DEPRECATED rtems_status_code rtems_disk_delete(dev_t dev);

/*
 * Use rtems_blkdev_create() or rtems_blkdev_create_partition and open()
 * instead.
 */
RTEMS_DEPRECATED rtems_disk_device *rtems_disk_obtain(dev_t dev);

/*
 * Use rtems_blkdev_create() or rtems_blkdev_create_partition and close()
 * instead.
 */
RTEMS_DEPRECATED rtems_status_code rtems_disk_release(rtems_disk_device *dd);

/* Just remove calls to this function */
RTEMS_DEPRECATED rtems_status_code rtems_disk_io_initialize(void);

/* Just remove calls to this function */
RTEMS_DEPRECATED rtems_status_code rtems_disk_io_done(void);

/*
 * This functionality no longer available.  There is no global registration for
 * disk devices.
 */
RTEMS_DEPRECATED rtems_disk_device *rtems_disk_next(dev_t dev);

/* Internal function, do not use */
rtems_status_code rtems_disk_init_phys(
  rtems_disk_device *dd,
  uint32_t block_size,
  rtems_blkdev_bnum block_count,
  rtems_block_device_ioctl handler,
  void *driver_data
);

/* Internal function, do not use */
rtems_status_code rtems_disk_init_log(
  rtems_disk_device *dd,
  rtems_disk_device *phys_dd,
  rtems_blkdev_bnum block_begin,
  rtems_blkdev_bnum block_count
);

#ifdef __cplusplus
}
#endif

#endif