jffs2.h

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2013, 2016 embedded brains GmbH & Co. KG
 *
 * 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 RTEMS_JFFS2_H
#define RTEMS_JFFS2_H
 
#include <rtems/fs.h>
#include <sys/param.h>
#include <sys/ioccom.h>
#include <zlib.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef struct rtems_jffs2_flash_control rtems_jffs2_flash_control;


typedef int (*rtems_jffs2_flash_read)(
  rtems_jffs2_flash_control *self,
  uint32_t offset,
  unsigned char *buffer,
  size_t size_of_buffer
);

typedef int (*rtems_jffs2_flash_write)(
  rtems_jffs2_flash_control *self,
  uint32_t offset,
  const unsigned char *buffer,
  size_t size_of_buffer
);

typedef int (*rtems_jffs2_flash_erase)(
  rtems_jffs2_flash_control *self,
  uint32_t offset
);

typedef int (*rtems_jffs2_flash_block_is_bad)(
  rtems_jffs2_flash_control *self,
  uint32_t offset,
  bool *bad
);

typedef int (*rtems_jffs2_flash_block_mark_bad)(
  rtems_jffs2_flash_control *self,
  uint32_t offset
);

typedef int (*rtems_jffs2_flash_oob_write)(
  rtems_jffs2_flash_control *self,
  uint32_t offset,
  uint8_t *oobbuf,
  uint32_t obblen
);

typedef int (*rtems_jffs2_flash_oob_read)(
  rtems_jffs2_flash_control *self,
  uint32_t offset,
  uint8_t *oobbuf,
  uint32_t obblen
);

typedef uint32_t (*rtems_jffs2_flash_get_oob_size)(
  rtems_jffs2_flash_control *self
);

typedef void (*rtems_jffs2_flash_destroy)(
  rtems_jffs2_flash_control *self
);

typedef void (*rtems_jffs2_trigger_garbage_collection)(
  rtems_jffs2_flash_control *self
);

struct rtems_jffs2_flash_control {
  uint32_t block_size;

  uint32_t flash_size;

  uint32_t write_size;

  rtems_jffs2_flash_read read;

  rtems_jffs2_flash_write write;

  rtems_jffs2_flash_erase erase;

  rtems_jffs2_flash_block_is_bad block_is_bad;

  rtems_jffs2_flash_block_mark_bad block_mark_bad;

  rtems_jffs2_flash_oob_write oob_write;

  rtems_jffs2_flash_oob_read oob_read;

  rtems_jffs2_flash_get_oob_size get_oob_size;

  rtems_jffs2_flash_destroy destroy;

  dev_t device_identifier;

  rtems_jffs2_trigger_garbage_collection trigger_garbage_collection;
};
 
typedef struct rtems_jffs2_compressor_control rtems_jffs2_compressor_control;

typedef uint16_t (*rtems_jffs2_compressor_compress)(
  rtems_jffs2_compressor_control *self,
  unsigned char *data_in,
  unsigned char *cdata_out,
  uint32_t *datalen,
  uint32_t *cdatalen
);

typedef int (*rtems_jffs2_compressor_decompress)(
  rtems_jffs2_compressor_control *self,
  uint16_t comprtype,
  unsigned char *cdata_in,
  unsigned char *data_out,
  uint32_t cdatalen,
  uint32_t datalen
);

typedef void (*rtems_jffs2_compressor_destroy)(
  rtems_jffs2_compressor_control *self
);

struct rtems_jffs2_compressor_control {
  rtems_jffs2_compressor_compress compress;

  rtems_jffs2_compressor_decompress decompress;

  rtems_jffs2_compressor_destroy destroy;

  unsigned char buffer[PAGE_SIZE];
};

uint16_t rtems_jffs2_compressor_rtime_compress(
  rtems_jffs2_compressor_control *self,
  unsigned char *data_in,
  unsigned char *cdata_out,
  uint32_t *datalen,
  uint32_t *cdatalen
);

int rtems_jffs2_compressor_rtime_decompress(
  rtems_jffs2_compressor_control *self,
  uint16_t comprtype,
  unsigned char *cdata_in,
  unsigned char *data_out,
  uint32_t cdatalen,
  uint32_t datalen
);

typedef struct {
  rtems_jffs2_compressor_control super;
  z_stream stream;
} rtems_jffs2_compressor_zlib_control;

uint16_t rtems_jffs2_compressor_zlib_compress(
  rtems_jffs2_compressor_control *self,
  unsigned char *data_in,
  unsigned char *cdata_out,
  uint32_t *datalen,
  uint32_t *cdatalen
);

int rtems_jffs2_compressor_zlib_decompress(
  rtems_jffs2_compressor_control *self,
  uint16_t comprtype,
  unsigned char *cdata_in,
  unsigned char *data_out,
  uint32_t cdatalen,
  uint32_t datalen
);

typedef struct {
  rtems_jffs2_flash_control *flash_control;

  rtems_jffs2_compressor_control *compressor_control;
} rtems_jffs2_mount_data;

int rtems_jffs2_initialize(
  rtems_filesystem_mount_table_entry_t *mt_entry,
  const void *data
);

typedef struct {
  uint32_t flash_size;

  uint32_t flash_blocks;

  uint32_t flash_block_size;

  uint32_t used_size;

  uint32_t dirty_size;

  uint32_t wasted_size;

  uint32_t free_size;

  uint32_t bad_size;

  uint32_t clean_blocks;

  uint32_t dirty_blocks;

  uint32_t erasable_blocks;

  uint32_t free_blocks;

  uint32_t bad_blocks;
} rtems_jffs2_info;

#define RTEMS_JFFS2_GET_INFO _IOR('F', 1, rtems_jffs2_info)

#define RTEMS_JFFS2_ON_DEMAND_GARBAGE_COLLECTION _IO('F', 2)

#define RTEMS_JFFS2_FORCE_GARBAGE_COLLECTION _IO('F', 3)

#define RTEMS_JFFS2_DELAYED_WRITE_TASK_PRIORITY_DEFAULT 15

typedef struct rtems_jffs2_config {
  rtems_task_priority delayed_write_priority; 
} rtems_jffs2_config;

extern const rtems_jffs2_config jffs2_config;

 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* RTEMS_JFFS2_H */