1/* Blackfin Serial Peripheral Interface (SPI) model 2 3 Copyright (C) 2010-2023 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/* This must come before any other includes. */ 22#include "defs.h" 23 24#include "sim-main.h" 25#include "devices.h" 26#include "dv-bfin_spi.h" 27 28/* XXX: This is merely a stub. */ 29 30struct bfin_spi 31{ 32 /* This top portion matches common dv_bfin struct. */ 33 bu32 base; 34 struct hw *dma_master; 35 bool acked; 36 37 struct hw_event *handler; 38 char saved_byte; 39 int saved_count; 40 41 /* Order after here is important -- matches hardware MMR layout. */ 42 bu16 BFIN_MMR_16(ctl); 43 bu16 BFIN_MMR_16(flg); 44 bu16 BFIN_MMR_16(stat); 45 bu16 BFIN_MMR_16(tdbr); 46 bu16 BFIN_MMR_16(rdbr); 47 bu16 BFIN_MMR_16(baud); 48 bu16 BFIN_MMR_16(shadow); 49}; 50#define mmr_base() offsetof(struct bfin_spi, ctl) 51#define mmr_offset(mmr) (offsetof(struct bfin_spi, mmr) - mmr_base()) 52 53static const char * const mmr_names[] = 54{ 55 "SPI_CTL", "SPI_FLG", "SPI_STAT", "SPI_TDBR", 56 "SPI_RDBR", "SPI_BAUD", "SPI_SHADOW", 57}; 58#define mmr_name(off) mmr_names[(off) / 4] 59 60static bool 61bfin_spi_enabled (struct bfin_spi *spi) 62{ 63 return (spi->ctl & SPE); 64} 65 66static bu16 67bfin_spi_timod (struct bfin_spi *spi) 68{ 69 return (spi->ctl & TIMOD); 70} 71 72static unsigned 73bfin_spi_io_write_buffer (struct hw *me, const void *source, int space, 74 address_word addr, unsigned nr_bytes) 75{ 76 struct bfin_spi *spi = hw_data (me); 77 bu32 mmr_off; 78 bu32 value; 79 bu16 *valuep; 80 81 /* Invalid access mode is higher priority than missing register. */ 82 if (!dv_bfin_mmr_require_16 (me, addr, nr_bytes, true)) 83 return 0; 84 85 value = dv_load_2 (source); 86 mmr_off = addr - spi->base; 87 valuep = (void *)((uintptr_t)spi + mmr_base() + mmr_off); 88 89 HW_TRACE_WRITE (); 90 91 switch (mmr_off) 92 { 93 case mmr_offset(stat): 94 dv_w1c_2 (valuep, value, ~(SPIF | TXS | RXS)); 95 break; 96 case mmr_offset(tdbr): 97 *valuep = value; 98 if (bfin_spi_enabled (spi) && bfin_spi_timod (spi) == TDBR_CORE) 99 { 100 spi->stat |= RXS; 101 spi->stat &= ~TXS; 102 } 103 break; 104 case mmr_offset(rdbr): 105 case mmr_offset(ctl): 106 case mmr_offset(flg): 107 case mmr_offset(baud): 108 case mmr_offset(shadow): 109 *valuep = value; 110 break; 111 default: 112 dv_bfin_mmr_invalid (me, addr, nr_bytes, true); 113 return 0; 114 } 115 116 return nr_bytes; 117} 118 119static unsigned 120bfin_spi_io_read_buffer (struct hw *me, void *dest, int space, 121 address_word addr, unsigned nr_bytes) 122{ 123 struct bfin_spi *spi = hw_data (me); 124 bu32 mmr_off; 125 bu16 *valuep; 126 127 /* Invalid access mode is higher priority than missing register. */ 128 if (!dv_bfin_mmr_require_16 (me, addr, nr_bytes, false)) 129 return 0; 130 131 mmr_off = addr - spi->base; 132 valuep = (void *)((uintptr_t)spi + mmr_base() + mmr_off); 133 134 HW_TRACE_READ (); 135 136 switch (mmr_off) 137 { 138 case mmr_offset(rdbr): 139 dv_store_2 (dest, *valuep); 140 if (bfin_spi_enabled (spi) && bfin_spi_timod (spi) == RDBR_CORE) 141 spi->stat &= ~(RXS | TXS); 142 break; 143 case mmr_offset(ctl): 144 case mmr_offset(stat): 145 case mmr_offset(flg): 146 case mmr_offset(tdbr): 147 case mmr_offset(baud): 148 case mmr_offset(shadow): 149 dv_store_2 (dest, *valuep); 150 break; 151 default: 152 dv_bfin_mmr_invalid (me, addr, nr_bytes, false); 153 return 0; 154 } 155 156 return nr_bytes; 157} 158 159static unsigned 160bfin_spi_dma_read_buffer (struct hw *me, void *dest, int space, 161 unsigned_word addr, unsigned nr_bytes) 162{ 163 HW_TRACE_DMA_READ (); 164 return 0; 165} 166 167static unsigned 168bfin_spi_dma_write_buffer (struct hw *me, const void *source, 169 int space, unsigned_word addr, 170 unsigned nr_bytes, 171 int violate_read_only_section) 172{ 173 HW_TRACE_DMA_WRITE (); 174 return 0; 175} 176 177static const struct hw_port_descriptor bfin_spi_ports[] = 178{ 179 { "stat", 0, 0, output_port, }, 180 { NULL, 0, 0, 0, }, 181}; 182 183static void 184attach_bfin_spi_regs (struct hw *me, struct bfin_spi *spi) 185{ 186 address_word attach_address; 187 int attach_space; 188 unsigned attach_size; 189 reg_property_spec reg; 190 191 if (hw_find_property (me, "reg") == NULL) 192 hw_abort (me, "Missing \"reg\" property"); 193 194 if (!hw_find_reg_array_property (me, "reg", 0, ®)) 195 hw_abort (me, "\"reg\" property must contain three addr/size entries"); 196 197 hw_unit_address_to_attach_address (hw_parent (me), 198 ®.address, 199 &attach_space, &attach_address, me); 200 hw_unit_size_to_attach_size (hw_parent (me), ®.size, &attach_size, me); 201 202 if (attach_size != BFIN_MMR_SPI_SIZE) 203 hw_abort (me, "\"reg\" size must be %#x", BFIN_MMR_SPI_SIZE); 204 205 hw_attach_address (hw_parent (me), 206 0, attach_space, attach_address, attach_size, me); 207 208 spi->base = attach_address; 209} 210 211static void 212bfin_spi_finish (struct hw *me) 213{ 214 struct bfin_spi *spi; 215 216 spi = HW_ZALLOC (me, struct bfin_spi); 217 218 set_hw_data (me, spi); 219 set_hw_io_read_buffer (me, bfin_spi_io_read_buffer); 220 set_hw_io_write_buffer (me, bfin_spi_io_write_buffer); 221 set_hw_dma_read_buffer (me, bfin_spi_dma_read_buffer); 222 set_hw_dma_write_buffer (me, bfin_spi_dma_write_buffer); 223 set_hw_ports (me, bfin_spi_ports); 224 225 attach_bfin_spi_regs (me, spi); 226 227 /* Initialize the SPI. */ 228 spi->ctl = 0x0400; 229 spi->flg = 0xFF00; 230 spi->stat = 0x0001; 231} 232 233const struct hw_descriptor dv_bfin_spi_descriptor[] = 234{ 235 {"bfin_spi", bfin_spi_finish,}, 236 {NULL, NULL}, 237}; 238