sys/dev/nand/nand_dev.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (C) 2009-2012 Semihalf
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _DEV_NAND_CDEV_H_
  32 #define _DEV_NAND_CDEV_H_
  33
  34 #include <sys/ioccom.h>
  35 #include <sys/param.h>
  36
  37 struct nand_raw_rw {
  38         off_t   off;
  39         off_t   len;
  40         uint8_t *data;
  41 };
  42
  43 struct nand_oob_rw {
  44         uint32_t        page;
  45         off_t           len;
  46         uint8_t         *data;
  47 };
  48
  49 #define NAND_IOCTL_GROUP        'N'
  50 #define NAND_IO_ERASE           _IOWR(NAND_IOCTL_GROUP, 0x0, off_t[2])
  51
  52 #define NAND_IO_OOB_READ        _IOWR(NAND_IOCTL_GROUP, 0x1, struct nand_oob_rw)
  53
  54 #define NAND_IO_OOB_PROG        _IOWR(NAND_IOCTL_GROUP, 0x2, struct nand_oob_rw)
  55
  56 #define NAND_IO_RAW_READ        _IOWR(NAND_IOCTL_GROUP, 0x3, struct nand_raw_rw)
  57
  58 #define NAND_IO_RAW_PROG        _IOWR(NAND_IOCTL_GROUP, 0x4, struct nand_raw_rw)
  59
  60 #define NAND_IO_GET_STATUS      _IOWR(NAND_IOCTL_GROUP, 0x5, uint8_t)
  61
  62 struct page_stat_io {
  63         uint32_t        page_num;
  64         uint32_t        page_read;
  65         uint32_t        page_written;
  66         uint32_t        page_raw_read;
  67         uint32_t        page_raw_written;
  68         uint32_t        ecc_succeded;
  69         uint32_t        ecc_corrected;
  70         uint32_t        ecc_failed;
  71 };
  72 #define NAND_IO_PAGE_STAT       _IOWR(NAND_IOCTL_GROUP, 0x6, \
  73     struct page_stat_io)
  74
  75 struct block_stat_io {
  76         uint32_t        block_num;
  77         uint32_t        block_erased;
  78 };
  79 #define NAND_IO_BLOCK_STAT      _IOWR(NAND_IOCTL_GROUP, 0x7, \
  80     struct block_stat_io)
  81
  82 struct chip_param_io {
  83         uint32_t        page_size;
  84         uint32_t        oob_size;
  85
  86         uint32_t        blocks;
  87         uint32_t        pages_per_block;
  88 };
  89 #define NAND_IO_GET_CHIP_PARAM  _IOWR(NAND_IOCTL_GROUP, 0x8, \
  90     struct chip_param_io)
  91
  92 #endif /* _DEV_NAND_CDEV_H_ */