sys/dev/nand/nandsim_swap.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 _NANDSIM_SWAP_CHIP_H_
  32 #define _NANDSIM_SWAP_CHIP_H_
  33
  34 struct block_space {
  35         SLIST_ENTRY(block_space)        free_link;
  36         STAILQ_ENTRY(block_space)       used_link;
  37         struct block_state              *blk_state;
  38         uint8_t                         *blk_ptr;
  39 };
  40
  41 #define BLOCK_ALLOCATED 0x1
  42 #define BLOCK_SWAPPED   0x2
  43 #define BLOCK_DIRTY     0x4
  44
  45 struct block_state {
  46         struct block_space      *blk_sp;
  47         uint32_t                offset;
  48         uint8_t                 status;
  49 };
  50
  51 struct chip_swap {
  52         struct block_state              *blk_state;
  53         SLIST_HEAD(,block_space)        free_bs;
  54         STAILQ_HEAD(,block_space)       used_bs;
  55         struct ucred                    *swap_cred;
  56         struct vnode                    *swap_vp;
  57         uint32_t                        swap_offset;
  58         uint32_t                        blk_size;
  59         uint32_t                        nof_blks;
  60 };
  61
  62 struct chip_swap *nandsim_swap_init(const char *, uint32_t, uint32_t);
  63 void nandsim_swap_destroy(struct chip_swap *);
  64 struct block_space *get_bs(struct chip_swap *, uint32_t, uint8_t);
  65
  66 #endif /* _NANDSIM_SWAP_CHIP_H_ */