sys/dev/nand/nand_dev.h

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