flashdev.h

Go to the documentation of this file.

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

 
/*
 * Copyright (C) 2023 Aaron Nyholm
 *
 * 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.
 */
 
#ifndef _DEV_FLASHDEV_H
#define _DEV_FLASHDEV_H
 
#include <rtems/thread.h>
#include <sys/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef struct rtems_flashdev rtems_flashdev;

 
/* IOCTL Calls */

#define RTEMS_FLASHDEV_IOCTL_OBTAIN 0
#define RTEMS_FLASHDEV_IOCTL_RELEASE 1
#define RTEMS_FLASHDEV_IOCTL_JEDEC_ID 2
#define RTEMS_FLASHDEV_IOCTL_ERASE 3
#define RTEMS_FLASHDEV_IOCTL_REGION_SET 4
#define RTEMS_FLASHDEV_IOCTL_REGION_UNSET 5
#define RTEMS_FLASHDEV_IOCTL_TYPE 6

#define RTEMS_FLASHDEV_IOCTL_PAGEINFO_BY_OFFSET 7

#define RTEMS_FLASHDEV_IOCTL_PAGEINFO_BY_INDEX 8

#define RTEMS_FLASHDEV_IOCTL_PAGE_COUNT 9

#define RTEMS_FLASHDEV_IOCTL_WRITE_BLOCK_SIZE 10

#define RTEMS_FLASHDEV_IOCTL_SECTORINFO_BY_OFFSET 11

#define RTEMS_FLASHDEV_IOCTL_SECTOR_COUNT 12

#define RTEMS_FLASHDEV_IOCTL_REGION_SECTORINFO_BY_OFFSET 13

#define RTEMS_FLASHDEV_IOCTL_OOB_BYTES_PER_PAGE 14

#define RTEMS_FLASHDEV_IOCTL_REGION_OOB_READ 15

#define RTEMS_FLASHDEV_IOCTL_REGION_OOB_WRITE 16

#define RTEMS_FLASHDEV_IOCTL_REGION_SECTOR_MARK_BAD 17

#define RTEMS_FLASHDEV_IOCTL_REGION_SECTOR_HEALTH 18

#define RTEMS_FLASHDEV_MAX_REGIONS 32

typedef enum rtems_flashdev_flash_type {
  RTEMS_FLASHDEV_NOR,
  RTEMS_FLASHDEV_NAND
} rtems_flashdev_flash_type;

typedef struct rtems_flashdev_region {
  off_t offset;
  size_t size;
} rtems_flashdev_region;

typedef struct rtems_flashdev_region_table {
  int max_regions;

  rtems_flashdev_region* regions;

  uint32_t *bit_allocator;
} rtems_flashdev_region_table;

typedef struct rtems_flashdev_ioctl_page_info {
  off_t location;

  rtems_flashdev_region page_info;
} rtems_flashdev_ioctl_page_info;

typedef struct rtems_flashdev_ioctl_sector_info {
  off_t location;

  rtems_flashdev_region sector_info;
} rtems_flashdev_ioctl_sector_info;

typedef struct rtems_flashdev_ioctl_sector_health {
  off_t location;

  uint8_t sector_bad;
} rtems_flashdev_ioctl_sector_health;

typedef struct rtems_flashdev_ioctl_oob_rw_info {
  off_t offset;

  void *buffer;

  size_t count;
} rtems_flashdev_ioctl_oob_rw_info;

struct rtems_flashdev {
  int ( *read )(
    rtems_flashdev *flash,
    uintptr_t offset,
    size_t count,
    void *buffer
  );

  int ( *write )(
    rtems_flashdev *flash,
    uintptr_t offset,
    size_t count,
    const void *buffer
  );

  int ( *erase )(
    rtems_flashdev *flash,
    uintptr_t offset,
    size_t count
  );

  uint32_t ( *jedec_id )(
    rtems_flashdev *flash
  );

  int ( *flash_type )(
    rtems_flashdev *flash,
    rtems_flashdev_flash_type *type
  );

  int ( *page_info_by_offset )(
    rtems_flashdev *flash,
    off_t search_offset,
    off_t *page_offset,
    size_t *page_size
  );

  int ( *page_info_by_index )(
    rtems_flashdev *flashdev,
    off_t search_index,
    off_t *page_offset,
    size_t *page_size
  );

  int ( *page_count )(
    rtems_flashdev *flashdev,
    int *page_count
  );

  int ( *write_block_size )(
    rtems_flashdev *flashdev,
    size_t *write_block_size
  );

  int ( *sector_info_by_offset )(
    rtems_flashdev *flash,
    off_t search_offset,
    off_t *sector_offset,
    size_t *sector_size
  );

  int ( *sector_count )(
    rtems_flashdev *flashdev,
    int *page_count
  );

  int ( *oob_bytes_per_page )(
    rtems_flashdev *flashdev,
    size_t *oob_bytes_per_page
  );

  int ( *oob_read )(
    rtems_flashdev *flash,
    uintptr_t offset,
    size_t count,
    void *buffer
  );

  int ( *oob_write )(
    rtems_flashdev *flash,
    uintptr_t offset,
    size_t count,
    const void *buffer
  );

  int ( *sector_mark_bad )(
    rtems_flashdev *flash,
    off_t offset
  );

  int ( *sector_health )(
    rtems_flashdev *flash,
    off_t search_offset,
    uint8_t *sector_bad
  );

  void ( *destroy )(
    rtems_flashdev *flashdev
  );

  void ( *priv_destroy )(
    rtems_flashdev *flashdev
  );

  void *driver;

  rtems_recursive_mutex mutex;

  rtems_flashdev_region_table *region_table;
};

rtems_flashdev *rtems_flashdev_alloc_and_init(
  size_t size
);

int rtems_flashdev_init(
  rtems_flashdev *flash
);

int rtems_flashdev_register(
  rtems_flashdev *flash,
  const char *flash_path
);

int rtems_flashdev_unregister(
  const char *flash_path
);

void rtems_flashdev_destroy(
  rtems_flashdev *flash
);

void rtems_flashdev_destroy_and_free(
  rtems_flashdev *flash
);
 
#ifdef __cplusplus
}
#endif

 
#endif /* _DEV_FLASHDEV_H */