1/* Blackfin NAND Flash Memory Controller (NFC) model 2 3 Copyright (C) 2010-2011 Free Software Foundation, Inc. 4 Contributed by Analog Devices, Inc. 5 6 This file is part of simulators. 7 8 This program is free software; you can redistribute it and/or modify 9 it under the terms of the GNU General Public License as published by 10 the Free Software Foundation; either version 3 of the License, or 11 (at your option) any later version. 12 13 This program is distributed in the hope that it will be useful, 14 but WITHOUT ANY WARRANTY; without even the implied warranty of 15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 GNU General Public License for more details. 17 18 You should have received a copy of the GNU General Public License 19 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 20 21#include "config.h" 22 23#include "sim-main.h" 24#include "devices.h" 25#include "dv-bfin_nfc.h" 26 27/* XXX: This is merely a stub. */ 28 29struct bfin_nfc 30{ 31 /* This top portion matches common dv_bfin struct. */ 32 bu32 base; 33 struct hw *dma_master; 34 bool acked; 35 36 struct hw_event *handler; 37 char saved_byte; 38 int saved_count; 39 40 /* Order after here is important -- matches hardware MMR layout. */ 41 bu16 BFIN_MMR_16(ctl); 42 bu16 BFIN_MMR_16(stat); 43 bu16 BFIN_MMR_16(irqstat); 44 bu16 BFIN_MMR_16(irqmask); 45 bu16 BFIN_MMR_16(ecc0); 46 bu16 BFIN_MMR_16(ecc1); 47 bu16 BFIN_MMR_16(ecc2); 48 bu16 BFIN_MMR_16(ecc3); 49 bu16 BFIN_MMR_16(count); 50 bu16 BFIN_MMR_16(rst); 51 bu16 BFIN_MMR_16(pgctl); 52 bu16 BFIN_MMR_16(read); 53 bu32 _pad0[4]; 54 bu16 BFIN_MMR_16(addr); 55 bu16 BFIN_MMR_16(cmd); 56 bu16 BFIN_MMR_16(data_wr); 57 bu16 BFIN_MMR_16(data_rd); 58}; 59#define mmr_base() offsetof(struct bfin_nfc, ctl) 60#define mmr_offset(mmr) (offsetof(struct bfin_nfc, mmr) - mmr_base()) 61#define mmr_idx(mmr) (mmr_offset (mmr) / 4) 62 63static const char * const mmr_names[] = 64{ 65 "NFC_CTL", "NFC_STAT", "NFC_IRQSTAT", "NFC_IRQMASK", "NFC_ECC0", "NFC_ECC1", 66 "NFC_ECC2", "NFC_ECC3", "NFC_COUNT", "NFC_RST", "NFC_PGCTL", "NFC_READ", 67 [mmr_idx (addr)] = "NFC_ADDR", "NFC_CMD", "NFC_DATA_WR", "NFC_DATA_RD", 68}; 69#define mmr_name(off) (mmr_names[(off) / 4] ? : "<INV>") 70 71static unsigned 72bfin_nfc_io_write_buffer (struct hw *me, const void *source, int space, 73 address_word addr, unsigned nr_bytes) 74{ 75 struct bfin_nfc *nfc = hw_data (me); 76 bu32 mmr_off; 77 bu32 value; 78 bu16 *valuep; 79 80 value = dv_load_2 (source); 81 mmr_off = addr - nfc->base; 82 valuep = (void *)((unsigned long)nfc + mmr_base() + mmr_off); 83 84 HW_TRACE_WRITE (); 85 86 dv_bfin_mmr_require_16 (me, addr, nr_bytes, true); 87 88 switch (mmr_off) 89 { 90 case mmr_offset(ctl): 91 case mmr_offset(stat): 92 case mmr_offset(irqmask): 93 case mmr_offset(ecc0): 94 case mmr_offset(ecc1): 95 case mmr_offset(ecc2): 96 case mmr_offset(ecc3): 97 case mmr_offset(count): 98 case mmr_offset(rst): 99 case mmr_offset(pgctl): 100 case mmr_offset(read): 101 case mmr_offset(addr): 102 case mmr_offset(cmd): 103 case mmr_offset(data_wr): 104 *valuep = value; 105 break; 106 case mmr_offset(data_rd): 107 nfc->irqstat |= RD_RDY; 108 *valuep = value; 109 break; 110 case mmr_offset(irqstat): 111 dv_w1c_2 (valuep, value, -1); 112 break; 113 default: 114 dv_bfin_mmr_invalid (me, addr, nr_bytes, true); 115 break; 116 } 117 118 return nr_bytes; 119} 120 121static unsigned 122bfin_nfc_io_read_buffer (struct hw *me, void *dest, int space, 123 address_word addr, unsigned nr_bytes) 124{ 125 struct bfin_nfc *nfc = hw_data (me); 126 bu32 mmr_off; 127 bu16 *valuep; 128 129 mmr_off = addr - nfc->base; 130 valuep = (void *)((unsigned long)nfc + mmr_base() + mmr_off); 131 132 HW_TRACE_READ (); 133 134 dv_bfin_mmr_require_16 (me, addr, nr_bytes, false); 135 136 switch (mmr_off) 137 { 138 case mmr_offset(ctl): 139 case mmr_offset(stat): 140 case mmr_offset(irqstat): 141 case mmr_offset(irqmask): 142 case mmr_offset(ecc0): 143 case mmr_offset(ecc1): 144 case mmr_offset(ecc2): 145 case mmr_offset(ecc3): 146 case mmr_offset(count): 147 case mmr_offset(rst): 148 case mmr_offset(read): 149 dv_store_2 (dest, *valuep); 150 break; 151 case mmr_offset(pgctl): 152 case mmr_offset(addr): 153 case mmr_offset(cmd): 154 case mmr_offset(data_wr): 155 case mmr_offset(data_rd): 156 /* These regs are write only. */ 157 default: 158 dv_bfin_mmr_invalid (me, addr, nr_bytes, false); 159 break; 160 } 161 162 return nr_bytes; 163} 164 165static unsigned 166bfin_nfc_dma_read_buffer (struct hw *me, void *dest, int space, 167 unsigned_word addr, unsigned nr_bytes) 168{ 169 HW_TRACE_DMA_READ (); 170 return 0; 171} 172 173static unsigned 174bfin_nfc_dma_write_buffer (struct hw *me, const void *source, 175 int space, unsigned_word addr, 176 unsigned nr_bytes, 177 int violate_read_only_section) 178{ 179 HW_TRACE_DMA_WRITE (); 180 return nr_bytes; 181} 182 183static const struct hw_port_descriptor bfin_nfc_ports[] = 184{ 185 { "stat", 0, 0, output_port, }, 186 { NULL, 0, 0, 0, }, 187}; 188 189static void 190attach_bfin_nfc_regs (struct hw *me, struct bfin_nfc *nfc) 191{ 192 address_word attach_address; 193 int attach_space; 194 unsigned attach_size; 195 reg_property_spec reg; 196 197 if (hw_find_property (me, "reg") == NULL) 198 hw_abort (me, "Missing \"reg\" property"); 199 200 if (!hw_find_reg_array_property (me, "reg", 0, ®)) 201 hw_abort (me, "\"reg\" property must contain three addr/size entries"); 202 203 hw_unit_address_to_attach_address (hw_parent (me), 204 ®.address, 205 &attach_space, &attach_address, me); 206 hw_unit_size_to_attach_size (hw_parent (me), ®.size, &attach_size, me); 207 208 if (attach_size != BFIN_MMR_NFC_SIZE) 209 hw_abort (me, "\"reg\" size must be %#x", BFIN_MMR_NFC_SIZE); 210 211 hw_attach_address (hw_parent (me), 212 0, attach_space, attach_address, attach_size, me); 213 214 nfc->base = attach_address; 215} 216 217static void 218bfin_nfc_finish (struct hw *me) 219{ 220 struct bfin_nfc *nfc; 221 222 nfc = HW_ZALLOC (me, struct bfin_nfc); 223 224 set_hw_data (me, nfc); 225 set_hw_io_read_buffer (me, bfin_nfc_io_read_buffer); 226 set_hw_io_write_buffer (me, bfin_nfc_io_write_buffer); 227 set_hw_dma_read_buffer (me, bfin_nfc_dma_read_buffer); 228 set_hw_dma_write_buffer (me, bfin_nfc_dma_write_buffer); 229 set_hw_ports (me, bfin_nfc_ports); 230 231 attach_bfin_nfc_regs (me, nfc); 232 233 /* Initialize the NFC. */ 234 nfc->ctl = 0x0200; 235 nfc->stat = 0x0011; 236 nfc->irqstat = 0x0004; 237 nfc->irqmask = 0x001F; 238} 239 240const struct hw_descriptor dv_bfin_nfc_descriptor[] = 241{ 242 {"bfin_nfc", bfin_nfc_finish,}, 243 {NULL, NULL}, 244}; 245