2 * ASPEED AST2400 SMC Controller (SPI Flash Only)
4 * Copyright (C) 2016 IBM Corp.
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include "hw/sysbus.h"
27 #include "sysemu/sysemu.h"
29 #include "qemu/error-report.h"
31 #include "hw/ssi/aspeed_smc.h"
33 /* CE Type Setting Register */
34 #define R_CONF (0x00 / 4)
35 #define CONF_LEGACY_DISABLE (1 << 31)
36 #define CONF_ENABLE_W4 20
37 #define CONF_ENABLE_W3 19
38 #define CONF_ENABLE_W2 18
39 #define CONF_ENABLE_W1 17
40 #define CONF_ENABLE_W0 16
41 #define CONF_FLASH_TYPE4 8
42 #define CONF_FLASH_TYPE3 6
43 #define CONF_FLASH_TYPE2 4
44 #define CONF_FLASH_TYPE1 2
45 #define CONF_FLASH_TYPE0 0
46 #define CONF_FLASH_TYPE_NOR 0x0
47 #define CONF_FLASH_TYPE_NAND 0x1
48 #define CONF_FLASH_TYPE_SPI 0x2
50 /* CE Control Register */
51 #define R_CE_CTRL (0x04 / 4)
52 #define CTRL_EXTENDED4 4 /* 32 bit addressing for SPI */
53 #define CTRL_EXTENDED3 3 /* 32 bit addressing for SPI */
54 #define CTRL_EXTENDED2 2 /* 32 bit addressing for SPI */
55 #define CTRL_EXTENDED1 1 /* 32 bit addressing for SPI */
56 #define CTRL_EXTENDED0 0 /* 32 bit addressing for SPI */
58 /* Interrupt Control and Status Register */
59 #define R_INTR_CTRL (0x08 / 4)
60 #define INTR_CTRL_DMA_STATUS (1 << 11)
61 #define INTR_CTRL_CMD_ABORT_STATUS (1 << 10)
62 #define INTR_CTRL_WRITE_PROTECT_STATUS (1 << 9)
63 #define INTR_CTRL_DMA_EN (1 << 3)
64 #define INTR_CTRL_CMD_ABORT_EN (1 << 2)
65 #define INTR_CTRL_WRITE_PROTECT_EN (1 << 1)
67 /* CEx Control Register */
68 #define R_CTRL0 (0x10 / 4)
69 #define CTRL_IO_DUAL_DATA (1 << 29)
70 #define CTRL_IO_DUAL_ADDR_DATA (1 << 28) /* Includes dummies */
71 #define CTRL_CMD_SHIFT 16
72 #define CTRL_CMD_MASK 0xff
73 #define CTRL_DUMMY_HIGH_SHIFT 14
74 #define CTRL_AST2400_SPI_4BYTE (1 << 13)
75 #define CTRL_DUMMY_LOW_SHIFT 6 /* 2 bits [7:6] */
76 #define CTRL_CE_STOP_ACTIVE (1 << 2)
77 #define CTRL_CMD_MODE_MASK 0x3
78 #define CTRL_READMODE 0x0
79 #define CTRL_FREADMODE 0x1
80 #define CTRL_WRITEMODE 0x2
81 #define CTRL_USERMODE 0x3
82 #define R_CTRL1 (0x14 / 4)
83 #define R_CTRL2 (0x18 / 4)
84 #define R_CTRL3 (0x1C / 4)
85 #define R_CTRL4 (0x20 / 4)
87 /* CEx Segment Address Register */
88 #define R_SEG_ADDR0 (0x30 / 4)
89 #define SEG_END_SHIFT 24 /* 8MB units */
90 #define SEG_END_MASK 0xff
91 #define SEG_START_SHIFT 16 /* address bit [A29-A23] */
92 #define SEG_START_MASK 0xff
93 #define R_SEG_ADDR1 (0x34 / 4)
94 #define R_SEG_ADDR2 (0x38 / 4)
95 #define R_SEG_ADDR3 (0x3C / 4)
96 #define R_SEG_ADDR4 (0x40 / 4)
98 /* Misc Control Register #1 */
99 #define R_MISC_CTRL1 (0x50 / 4)
101 /* SPI dummy cycle data */
102 #define R_DUMMY_DATA (0x54 / 4)
104 /* DMA Control/Status Register */
105 #define R_DMA_CTRL (0x80 / 4)
106 #define DMA_CTRL_DELAY_MASK 0xf
107 #define DMA_CTRL_DELAY_SHIFT 8
108 #define DMA_CTRL_FREQ_MASK 0xf
109 #define DMA_CTRL_FREQ_SHIFT 4
110 #define DMA_CTRL_MODE (1 << 3)
111 #define DMA_CTRL_CKSUM (1 << 2)
112 #define DMA_CTRL_DIR (1 << 1)
113 #define DMA_CTRL_EN (1 << 0)
115 /* DMA Flash Side Address */
116 #define R_DMA_FLASH_ADDR (0x84 / 4)
118 /* DMA DRAM Side Address */
119 #define R_DMA_DRAM_ADDR (0x88 / 4)
121 /* DMA Length Register */
122 #define R_DMA_LEN (0x8C / 4)
124 /* Checksum Calculation Result */
125 #define R_DMA_CHECKSUM (0x90 / 4)
127 /* Misc Control Register #2 */
128 #define R_TIMINGS (0x94 / 4)
130 /* SPI controller registers and bits */
131 #define R_SPI_CONF (0x00 / 4)
132 #define SPI_CONF_ENABLE_W0 0
133 #define R_SPI_CTRL0 (0x4 / 4)
134 #define R_SPI_MISC_CTRL (0x10 / 4)
135 #define R_SPI_TIMINGS (0x14 / 4)
137 #define ASPEED_SMC_R_SPI_MAX (0x20 / 4)
138 #define ASPEED_SMC_R_SMC_MAX (0x20 / 4)
140 #define ASPEED_SOC_SMC_FLASH_BASE 0x10000000
141 #define ASPEED_SOC_FMC_FLASH_BASE 0x20000000
142 #define ASPEED_SOC_SPI_FLASH_BASE 0x30000000
143 #define ASPEED_SOC_SPI2_FLASH_BASE 0x38000000
146 #define SPI_OP_READ 0x03 /* Read data bytes (low frequency) */
148 #define SNOOP_OFF 0xFF
149 #define SNOOP_START 0x0
152 * Default segments mapping addresses and size for each slave per
153 * controller. These can be changed when board is initialized with the
154 * Segment Address Registers.
156 static const AspeedSegments aspeed_segments_legacy
[] = {
157 { 0x10000000, 32 * 1024 * 1024 },
160 static const AspeedSegments aspeed_segments_fmc
[] = {
161 { 0x20000000, 64 * 1024 * 1024 }, /* start address is readonly */
162 { 0x24000000, 32 * 1024 * 1024 },
163 { 0x26000000, 32 * 1024 * 1024 },
164 { 0x28000000, 32 * 1024 * 1024 },
165 { 0x2A000000, 32 * 1024 * 1024 }
168 static const AspeedSegments aspeed_segments_spi
[] = {
169 { 0x30000000, 64 * 1024 * 1024 },
172 static const AspeedSegments aspeed_segments_ast2500_fmc
[] = {
173 { 0x20000000, 128 * 1024 * 1024 }, /* start address is readonly */
174 { 0x28000000, 32 * 1024 * 1024 },
175 { 0x2A000000, 32 * 1024 * 1024 },
178 static const AspeedSegments aspeed_segments_ast2500_spi1
[] = {
179 { 0x30000000, 32 * 1024 * 1024 }, /* start address is readonly */
180 { 0x32000000, 96 * 1024 * 1024 }, /* end address is readonly */
183 static const AspeedSegments aspeed_segments_ast2500_spi2
[] = {
184 { 0x38000000, 32 * 1024 * 1024 }, /* start address is readonly */
185 { 0x3A000000, 96 * 1024 * 1024 }, /* end address is readonly */
188 static const AspeedSMCController controllers
[] = {
190 .name
= "aspeed.smc.smc",
192 .r_ce_ctrl
= R_CE_CTRL
,
194 .r_timings
= R_TIMINGS
,
195 .conf_enable_w0
= CONF_ENABLE_W0
,
197 .segments
= aspeed_segments_legacy
,
198 .flash_window_base
= ASPEED_SOC_SMC_FLASH_BASE
,
199 .flash_window_size
= 0x6000000,
201 .nregs
= ASPEED_SMC_R_SMC_MAX
,
203 .name
= "aspeed.smc.fmc",
205 .r_ce_ctrl
= R_CE_CTRL
,
207 .r_timings
= R_TIMINGS
,
208 .conf_enable_w0
= CONF_ENABLE_W0
,
210 .segments
= aspeed_segments_fmc
,
211 .flash_window_base
= ASPEED_SOC_FMC_FLASH_BASE
,
212 .flash_window_size
= 0x10000000,
214 .nregs
= ASPEED_SMC_R_MAX
,
216 .name
= "aspeed.smc.spi",
217 .r_conf
= R_SPI_CONF
,
219 .r_ctrl0
= R_SPI_CTRL0
,
220 .r_timings
= R_SPI_TIMINGS
,
221 .conf_enable_w0
= SPI_CONF_ENABLE_W0
,
223 .segments
= aspeed_segments_spi
,
224 .flash_window_base
= ASPEED_SOC_SPI_FLASH_BASE
,
225 .flash_window_size
= 0x10000000,
227 .nregs
= ASPEED_SMC_R_SPI_MAX
,
229 .name
= "aspeed.smc.ast2500-fmc",
231 .r_ce_ctrl
= R_CE_CTRL
,
233 .r_timings
= R_TIMINGS
,
234 .conf_enable_w0
= CONF_ENABLE_W0
,
236 .segments
= aspeed_segments_ast2500_fmc
,
237 .flash_window_base
= ASPEED_SOC_FMC_FLASH_BASE
,
238 .flash_window_size
= 0x10000000,
240 .nregs
= ASPEED_SMC_R_MAX
,
242 .name
= "aspeed.smc.ast2500-spi1",
244 .r_ce_ctrl
= R_CE_CTRL
,
246 .r_timings
= R_TIMINGS
,
247 .conf_enable_w0
= CONF_ENABLE_W0
,
249 .segments
= aspeed_segments_ast2500_spi1
,
250 .flash_window_base
= ASPEED_SOC_SPI_FLASH_BASE
,
251 .flash_window_size
= 0x8000000,
253 .nregs
= ASPEED_SMC_R_MAX
,
255 .name
= "aspeed.smc.ast2500-spi2",
257 .r_ce_ctrl
= R_CE_CTRL
,
259 .r_timings
= R_TIMINGS
,
260 .conf_enable_w0
= CONF_ENABLE_W0
,
262 .segments
= aspeed_segments_ast2500_spi2
,
263 .flash_window_base
= ASPEED_SOC_SPI2_FLASH_BASE
,
264 .flash_window_size
= 0x8000000,
266 .nregs
= ASPEED_SMC_R_MAX
,
271 * The Segment Register uses a 8MB unit to encode the start address
272 * and the end address of the mapping window of a flash SPI slave :
274 * | byte 1 | byte 2 | byte 3 | byte 4 |
275 * +--------+--------+--------+--------+
276 * | end | start | 0 | 0 |
279 static inline uint32_t aspeed_smc_segment_to_reg(const AspeedSegments
*seg
)
282 reg
|= ((seg
->addr
>> 23) & SEG_START_MASK
) << SEG_START_SHIFT
;
283 reg
|= (((seg
->addr
+ seg
->size
) >> 23) & SEG_END_MASK
) << SEG_END_SHIFT
;
287 static inline void aspeed_smc_reg_to_segment(uint32_t reg
, AspeedSegments
*seg
)
289 seg
->addr
= ((reg
>> SEG_START_SHIFT
) & SEG_START_MASK
) << 23;
290 seg
->size
= (((reg
>> SEG_END_SHIFT
) & SEG_END_MASK
) << 23) - seg
->addr
;
293 static bool aspeed_smc_flash_overlap(const AspeedSMCState
*s
,
294 const AspeedSegments
*new,
300 for (i
= 0; i
< s
->ctrl
->max_slaves
; i
++) {
305 aspeed_smc_reg_to_segment(s
->regs
[R_SEG_ADDR0
+ i
], &seg
);
307 if (new->addr
+ new->size
> seg
.addr
&&
308 new->addr
< seg
.addr
+ seg
.size
) {
309 qemu_log_mask(LOG_GUEST_ERROR
, "%s: new segment CS%d [ 0x%"
310 HWADDR_PRIx
" - 0x%"HWADDR_PRIx
" ] overlaps with "
311 "CS%d [ 0x%"HWADDR_PRIx
" - 0x%"HWADDR_PRIx
" ]\n",
312 s
->ctrl
->name
, cs
, new->addr
, new->addr
+ new->size
,
313 i
, seg
.addr
, seg
.addr
+ seg
.size
);
320 static void aspeed_smc_flash_set_segment(AspeedSMCState
*s
, int cs
,
323 AspeedSMCFlash
*fl
= &s
->flashes
[cs
];
326 aspeed_smc_reg_to_segment(new, &seg
);
328 /* The start address of CS0 is read-only */
329 if (cs
== 0 && seg
.addr
!= s
->ctrl
->flash_window_base
) {
330 qemu_log_mask(LOG_GUEST_ERROR
,
331 "%s: Tried to change CS0 start address to 0x%"
332 HWADDR_PRIx
"\n", s
->ctrl
->name
, seg
.addr
);
333 seg
.addr
= s
->ctrl
->flash_window_base
;
334 new = aspeed_smc_segment_to_reg(&seg
);
338 * The end address of the AST2500 spi controllers is also
341 if ((s
->ctrl
->segments
== aspeed_segments_ast2500_spi1
||
342 s
->ctrl
->segments
== aspeed_segments_ast2500_spi2
) &&
343 cs
== s
->ctrl
->max_slaves
&&
344 seg
.addr
+ seg
.size
!= s
->ctrl
->segments
[cs
].addr
+
345 s
->ctrl
->segments
[cs
].size
) {
346 qemu_log_mask(LOG_GUEST_ERROR
,
347 "%s: Tried to change CS%d end address to 0x%"
348 HWADDR_PRIx
"\n", s
->ctrl
->name
, cs
, seg
.addr
+ seg
.size
);
349 seg
.size
= s
->ctrl
->segments
[cs
].addr
+ s
->ctrl
->segments
[cs
].size
-
351 new = aspeed_smc_segment_to_reg(&seg
);
354 /* Keep the segment in the overall flash window */
355 if (seg
.addr
+ seg
.size
<= s
->ctrl
->flash_window_base
||
356 seg
.addr
> s
->ctrl
->flash_window_base
+ s
->ctrl
->flash_window_size
) {
357 qemu_log_mask(LOG_GUEST_ERROR
, "%s: new segment for CS%d is invalid : "
358 "[ 0x%"HWADDR_PRIx
" - 0x%"HWADDR_PRIx
" ]\n",
359 s
->ctrl
->name
, cs
, seg
.addr
, seg
.addr
+ seg
.size
);
363 /* Check start address vs. alignment */
364 if (seg
.size
&& !QEMU_IS_ALIGNED(seg
.addr
, seg
.size
)) {
365 qemu_log_mask(LOG_GUEST_ERROR
, "%s: new segment for CS%d is not "
366 "aligned : [ 0x%"HWADDR_PRIx
" - 0x%"HWADDR_PRIx
" ]\n",
367 s
->ctrl
->name
, cs
, seg
.addr
, seg
.addr
+ seg
.size
);
370 /* And segments should not overlap (in the specs) */
371 aspeed_smc_flash_overlap(s
, &seg
, cs
);
373 /* All should be fine now to move the region */
374 memory_region_transaction_begin();
375 memory_region_set_size(&fl
->mmio
, seg
.size
);
376 memory_region_set_address(&fl
->mmio
, seg
.addr
- s
->ctrl
->flash_window_base
);
377 memory_region_set_enabled(&fl
->mmio
, true);
378 memory_region_transaction_commit();
380 s
->regs
[R_SEG_ADDR0
+ cs
] = new;
383 static uint64_t aspeed_smc_flash_default_read(void *opaque
, hwaddr addr
,
386 qemu_log_mask(LOG_GUEST_ERROR
, "%s: To 0x%" HWADDR_PRIx
" of size %u"
387 PRIx64
"\n", __func__
, addr
, size
);
391 static void aspeed_smc_flash_default_write(void *opaque
, hwaddr addr
,
392 uint64_t data
, unsigned size
)
394 qemu_log_mask(LOG_GUEST_ERROR
, "%s: To 0x%" HWADDR_PRIx
" of size %u: 0x%"
395 PRIx64
"\n", __func__
, addr
, size
, data
);
398 static const MemoryRegionOps aspeed_smc_flash_default_ops
= {
399 .read
= aspeed_smc_flash_default_read
,
400 .write
= aspeed_smc_flash_default_write
,
401 .endianness
= DEVICE_LITTLE_ENDIAN
,
403 .min_access_size
= 1,
404 .max_access_size
= 4,
408 static inline int aspeed_smc_flash_mode(const AspeedSMCFlash
*fl
)
410 const AspeedSMCState
*s
= fl
->controller
;
412 return s
->regs
[s
->r_ctrl0
+ fl
->id
] & CTRL_CMD_MODE_MASK
;
415 static inline bool aspeed_smc_is_writable(const AspeedSMCFlash
*fl
)
417 const AspeedSMCState
*s
= fl
->controller
;
419 return s
->regs
[s
->r_conf
] & (1 << (s
->conf_enable_w0
+ fl
->id
));
422 static inline int aspeed_smc_flash_cmd(const AspeedSMCFlash
*fl
)
424 const AspeedSMCState
*s
= fl
->controller
;
425 int cmd
= (s
->regs
[s
->r_ctrl0
+ fl
->id
] >> CTRL_CMD_SHIFT
) & CTRL_CMD_MASK
;
427 /* In read mode, the default SPI command is READ (0x3). In other
428 * modes, the command should necessarily be defined */
429 if (aspeed_smc_flash_mode(fl
) == CTRL_READMODE
) {
434 qemu_log_mask(LOG_GUEST_ERROR
, "%s: no command defined for mode %d\n",
435 __func__
, aspeed_smc_flash_mode(fl
));
441 static inline int aspeed_smc_flash_is_4byte(const AspeedSMCFlash
*fl
)
443 const AspeedSMCState
*s
= fl
->controller
;
445 if (s
->ctrl
->segments
== aspeed_segments_spi
) {
446 return s
->regs
[s
->r_ctrl0
] & CTRL_AST2400_SPI_4BYTE
;
448 return s
->regs
[s
->r_ce_ctrl
] & (1 << (CTRL_EXTENDED0
+ fl
->id
));
452 static inline bool aspeed_smc_is_ce_stop_active(const AspeedSMCFlash
*fl
)
454 const AspeedSMCState
*s
= fl
->controller
;
456 return s
->regs
[s
->r_ctrl0
+ fl
->id
] & CTRL_CE_STOP_ACTIVE
;
459 static void aspeed_smc_flash_select(AspeedSMCFlash
*fl
)
461 AspeedSMCState
*s
= fl
->controller
;
463 s
->regs
[s
->r_ctrl0
+ fl
->id
] &= ~CTRL_CE_STOP_ACTIVE
;
464 qemu_set_irq(s
->cs_lines
[fl
->id
], aspeed_smc_is_ce_stop_active(fl
));
467 static void aspeed_smc_flash_unselect(AspeedSMCFlash
*fl
)
469 AspeedSMCState
*s
= fl
->controller
;
471 s
->regs
[s
->r_ctrl0
+ fl
->id
] |= CTRL_CE_STOP_ACTIVE
;
472 qemu_set_irq(s
->cs_lines
[fl
->id
], aspeed_smc_is_ce_stop_active(fl
));
475 static uint32_t aspeed_smc_check_segment_addr(const AspeedSMCFlash
*fl
,
478 const AspeedSMCState
*s
= fl
->controller
;
481 aspeed_smc_reg_to_segment(s
->regs
[R_SEG_ADDR0
+ fl
->id
], &seg
);
482 if ((addr
% seg
.size
) != addr
) {
483 qemu_log_mask(LOG_GUEST_ERROR
,
484 "%s: invalid address 0x%08x for CS%d segment : "
485 "[ 0x%"HWADDR_PRIx
" - 0x%"HWADDR_PRIx
" ]\n",
486 s
->ctrl
->name
, addr
, fl
->id
, seg
.addr
,
487 seg
.addr
+ seg
.size
);
494 static int aspeed_smc_flash_dummies(const AspeedSMCFlash
*fl
)
496 const AspeedSMCState
*s
= fl
->controller
;
497 uint32_t r_ctrl0
= s
->regs
[s
->r_ctrl0
+ fl
->id
];
498 uint32_t dummy_high
= (r_ctrl0
>> CTRL_DUMMY_HIGH_SHIFT
) & 0x1;
499 uint32_t dummy_low
= (r_ctrl0
>> CTRL_DUMMY_LOW_SHIFT
) & 0x3;
500 uint32_t dummies
= ((dummy_high
<< 2) | dummy_low
) * 8;
502 if (r_ctrl0
& CTRL_IO_DUAL_ADDR_DATA
) {
509 static void aspeed_smc_flash_setup(AspeedSMCFlash
*fl
, uint32_t addr
)
511 const AspeedSMCState
*s
= fl
->controller
;
512 uint8_t cmd
= aspeed_smc_flash_cmd(fl
);
515 /* Flash access can not exceed CS segment */
516 addr
= aspeed_smc_check_segment_addr(fl
, addr
);
518 ssi_transfer(s
->spi
, cmd
);
520 if (aspeed_smc_flash_is_4byte(fl
)) {
521 ssi_transfer(s
->spi
, (addr
>> 24) & 0xff);
523 ssi_transfer(s
->spi
, (addr
>> 16) & 0xff);
524 ssi_transfer(s
->spi
, (addr
>> 8) & 0xff);
525 ssi_transfer(s
->spi
, (addr
& 0xff));
528 * Use fake transfers to model dummy bytes. The value should
529 * be configured to some non-zero value in fast read mode and
530 * zero in read mode. But, as the HW allows inconsistent
531 * settings, let's check for fast read mode.
533 if (aspeed_smc_flash_mode(fl
) == CTRL_FREADMODE
) {
534 for (i
= 0; i
< aspeed_smc_flash_dummies(fl
); i
++) {
535 ssi_transfer(fl
->controller
->spi
, s
->regs
[R_DUMMY_DATA
] & 0xff);
540 static uint64_t aspeed_smc_flash_read(void *opaque
, hwaddr addr
, unsigned size
)
542 AspeedSMCFlash
*fl
= opaque
;
543 AspeedSMCState
*s
= fl
->controller
;
547 switch (aspeed_smc_flash_mode(fl
)) {
549 for (i
= 0; i
< size
; i
++) {
550 ret
|= ssi_transfer(s
->spi
, 0x0) << (8 * i
);
555 aspeed_smc_flash_select(fl
);
556 aspeed_smc_flash_setup(fl
, addr
);
558 for (i
= 0; i
< size
; i
++) {
559 ret
|= ssi_transfer(s
->spi
, 0x0) << (8 * i
);
562 aspeed_smc_flash_unselect(fl
);
565 qemu_log_mask(LOG_GUEST_ERROR
, "%s: invalid flash mode %d\n",
566 __func__
, aspeed_smc_flash_mode(fl
));
573 * TODO (clg@kaod.org): stolen from xilinx_spips.c. Should move to a
574 * common include header.
577 READ
= 0x3, READ_4
= 0x13,
578 FAST_READ
= 0xb, FAST_READ_4
= 0x0c,
579 DOR
= 0x3b, DOR_4
= 0x3c,
580 QOR
= 0x6b, QOR_4
= 0x6c,
581 DIOR
= 0xbb, DIOR_4
= 0xbc,
582 QIOR
= 0xeb, QIOR_4
= 0xec,
584 PP
= 0x2, PP_4
= 0x12,
586 QPP
= 0x32, QPP_4
= 0x34,
589 static int aspeed_smc_num_dummies(uint8_t command
)
591 switch (command
) { /* check for dummies */
592 case READ
: /* no dummy bytes/cycles */
618 static bool aspeed_smc_do_snoop(AspeedSMCFlash
*fl
, uint64_t data
,
621 AspeedSMCState
*s
= fl
->controller
;
622 uint8_t addr_width
= aspeed_smc_flash_is_4byte(fl
) ? 4 : 3;
624 if (s
->snoop_index
== SNOOP_OFF
) {
625 return false; /* Do nothing */
627 } else if (s
->snoop_index
== SNOOP_START
) {
628 uint8_t cmd
= data
& 0xff;
629 int ndummies
= aspeed_smc_num_dummies(cmd
);
632 * No dummy cycles are expected with the current command. Turn
633 * off snooping and let the transfer proceed normally.
636 s
->snoop_index
= SNOOP_OFF
;
640 s
->snoop_dummies
= ndummies
* 8;
642 } else if (s
->snoop_index
>= addr_width
+ 1) {
644 /* The SPI transfer has reached the dummy cycles sequence */
645 for (; s
->snoop_dummies
; s
->snoop_dummies
--) {
646 ssi_transfer(s
->spi
, s
->regs
[R_DUMMY_DATA
] & 0xff);
649 /* If no more dummy cycles are expected, turn off snooping */
650 if (!s
->snoop_dummies
) {
651 s
->snoop_index
= SNOOP_OFF
;
653 s
->snoop_index
+= size
;
657 * Dummy cycles have been faked already. Ignore the current
663 s
->snoop_index
+= size
;
667 static void aspeed_smc_flash_write(void *opaque
, hwaddr addr
, uint64_t data
,
670 AspeedSMCFlash
*fl
= opaque
;
671 AspeedSMCState
*s
= fl
->controller
;
674 if (!aspeed_smc_is_writable(fl
)) {
675 qemu_log_mask(LOG_GUEST_ERROR
, "%s: flash is not writable at 0x%"
676 HWADDR_PRIx
"\n", __func__
, addr
);
680 switch (aspeed_smc_flash_mode(fl
)) {
682 if (aspeed_smc_do_snoop(fl
, data
, size
)) {
686 for (i
= 0; i
< size
; i
++) {
687 ssi_transfer(s
->spi
, (data
>> (8 * i
)) & 0xff);
691 aspeed_smc_flash_select(fl
);
692 aspeed_smc_flash_setup(fl
, addr
);
694 for (i
= 0; i
< size
; i
++) {
695 ssi_transfer(s
->spi
, (data
>> (8 * i
)) & 0xff);
698 aspeed_smc_flash_unselect(fl
);
701 qemu_log_mask(LOG_GUEST_ERROR
, "%s: invalid flash mode %d\n",
702 __func__
, aspeed_smc_flash_mode(fl
));
706 static const MemoryRegionOps aspeed_smc_flash_ops
= {
707 .read
= aspeed_smc_flash_read
,
708 .write
= aspeed_smc_flash_write
,
709 .endianness
= DEVICE_LITTLE_ENDIAN
,
711 .min_access_size
= 1,
712 .max_access_size
= 4,
716 static void aspeed_smc_flash_update_cs(AspeedSMCFlash
*fl
)
718 AspeedSMCState
*s
= fl
->controller
;
720 s
->snoop_index
= aspeed_smc_is_ce_stop_active(fl
) ? SNOOP_OFF
: SNOOP_START
;
722 qemu_set_irq(s
->cs_lines
[fl
->id
], aspeed_smc_is_ce_stop_active(fl
));
725 static void aspeed_smc_reset(DeviceState
*d
)
727 AspeedSMCState
*s
= ASPEED_SMC(d
);
730 memset(s
->regs
, 0, sizeof s
->regs
);
732 /* Pretend DMA is done (u-boot initialization) */
733 s
->regs
[R_INTR_CTRL
] = INTR_CTRL_DMA_STATUS
;
735 /* Unselect all slaves */
736 for (i
= 0; i
< s
->num_cs
; ++i
) {
737 s
->regs
[s
->r_ctrl0
+ i
] |= CTRL_CE_STOP_ACTIVE
;
738 qemu_set_irq(s
->cs_lines
[i
], true);
741 /* setup default segment register values for all */
742 for (i
= 0; i
< s
->ctrl
->max_slaves
; ++i
) {
743 s
->regs
[R_SEG_ADDR0
+ i
] =
744 aspeed_smc_segment_to_reg(&s
->ctrl
->segments
[i
]);
747 /* HW strapping flash type for FMC controllers */
748 if (s
->ctrl
->segments
== aspeed_segments_ast2500_fmc
) {
749 /* flash type is fixed to SPI for CE0 and CE1 */
750 s
->regs
[s
->r_conf
] |= (CONF_FLASH_TYPE_SPI
<< CONF_FLASH_TYPE0
);
751 s
->regs
[s
->r_conf
] |= (CONF_FLASH_TYPE_SPI
<< CONF_FLASH_TYPE1
);
754 /* HW strapping for AST2400 FMC controllers (SCU70). Let's use the
755 * configuration of the palmetto-bmc machine */
756 if (s
->ctrl
->segments
== aspeed_segments_fmc
) {
757 s
->regs
[s
->r_conf
] |= (CONF_FLASH_TYPE_SPI
<< CONF_FLASH_TYPE0
);
760 s
->snoop_index
= SNOOP_OFF
;
761 s
->snoop_dummies
= 0;
764 static uint64_t aspeed_smc_read(void *opaque
, hwaddr addr
, unsigned int size
)
766 AspeedSMCState
*s
= ASPEED_SMC(opaque
);
770 if (addr
== s
->r_conf
||
771 addr
== s
->r_timings
||
772 addr
== s
->r_ce_ctrl
||
773 addr
== R_INTR_CTRL
||
774 addr
== R_DUMMY_DATA
||
775 (addr
>= R_SEG_ADDR0
&& addr
< R_SEG_ADDR0
+ s
->ctrl
->max_slaves
) ||
776 (addr
>= s
->r_ctrl0
&& addr
< s
->r_ctrl0
+ s
->ctrl
->max_slaves
)) {
777 return s
->regs
[addr
];
779 qemu_log_mask(LOG_UNIMP
, "%s: not implemented: 0x%" HWADDR_PRIx
"\n",
785 static void aspeed_smc_write(void *opaque
, hwaddr addr
, uint64_t data
,
788 AspeedSMCState
*s
= ASPEED_SMC(opaque
);
789 uint32_t value
= data
;
793 if (addr
== s
->r_conf
||
794 addr
== s
->r_timings
||
795 addr
== s
->r_ce_ctrl
) {
796 s
->regs
[addr
] = value
;
797 } else if (addr
>= s
->r_ctrl0
&& addr
< s
->r_ctrl0
+ s
->num_cs
) {
798 int cs
= addr
- s
->r_ctrl0
;
799 s
->regs
[addr
] = value
;
800 aspeed_smc_flash_update_cs(&s
->flashes
[cs
]);
801 } else if (addr
>= R_SEG_ADDR0
&&
802 addr
< R_SEG_ADDR0
+ s
->ctrl
->max_slaves
) {
803 int cs
= addr
- R_SEG_ADDR0
;
805 if (value
!= s
->regs
[R_SEG_ADDR0
+ cs
]) {
806 aspeed_smc_flash_set_segment(s
, cs
, value
);
808 } else if (addr
== R_DUMMY_DATA
) {
809 s
->regs
[addr
] = value
& 0xff;
811 qemu_log_mask(LOG_UNIMP
, "%s: not implemented: 0x%" HWADDR_PRIx
"\n",
817 static const MemoryRegionOps aspeed_smc_ops
= {
818 .read
= aspeed_smc_read
,
819 .write
= aspeed_smc_write
,
820 .endianness
= DEVICE_LITTLE_ENDIAN
,
821 .valid
.unaligned
= true,
824 static void aspeed_smc_realize(DeviceState
*dev
, Error
**errp
)
826 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
827 AspeedSMCState
*s
= ASPEED_SMC(dev
);
828 AspeedSMCClass
*mc
= ASPEED_SMC_GET_CLASS(s
);
835 /* keep a copy under AspeedSMCState to speed up accesses */
836 s
->r_conf
= s
->ctrl
->r_conf
;
837 s
->r_ce_ctrl
= s
->ctrl
->r_ce_ctrl
;
838 s
->r_ctrl0
= s
->ctrl
->r_ctrl0
;
839 s
->r_timings
= s
->ctrl
->r_timings
;
840 s
->conf_enable_w0
= s
->ctrl
->conf_enable_w0
;
842 /* Enforce some real HW limits */
843 if (s
->num_cs
> s
->ctrl
->max_slaves
) {
844 qemu_log_mask(LOG_GUEST_ERROR
, "%s: num_cs cannot exceed: %d\n",
845 __func__
, s
->ctrl
->max_slaves
);
846 s
->num_cs
= s
->ctrl
->max_slaves
;
849 s
->spi
= ssi_create_bus(dev
, "spi");
851 /* Setup cs_lines for slaves */
852 sysbus_init_irq(sbd
, &s
->irq
);
853 s
->cs_lines
= g_new0(qemu_irq
, s
->num_cs
);
854 ssi_auto_connect_slaves(dev
, s
->cs_lines
, s
->spi
);
856 for (i
= 0; i
< s
->num_cs
; ++i
) {
857 sysbus_init_irq(sbd
, &s
->cs_lines
[i
]);
860 /* The memory region for the controller registers */
861 memory_region_init_io(&s
->mmio
, OBJECT(s
), &aspeed_smc_ops
, s
,
862 s
->ctrl
->name
, s
->ctrl
->nregs
* 4);
863 sysbus_init_mmio(sbd
, &s
->mmio
);
866 * The container memory region representing the address space
867 * window in which the flash modules are mapped. The size and
868 * address depends on the SoC model and controller type.
870 snprintf(name
, sizeof(name
), "%s.flash", s
->ctrl
->name
);
872 memory_region_init_io(&s
->mmio_flash
, OBJECT(s
),
873 &aspeed_smc_flash_default_ops
, s
, name
,
874 s
->ctrl
->flash_window_size
);
875 sysbus_init_mmio(sbd
, &s
->mmio_flash
);
877 s
->flashes
= g_new0(AspeedSMCFlash
, s
->ctrl
->max_slaves
);
880 * Let's create a sub memory region for each possible slave. All
881 * have a configurable memory segment in the overall flash mapping
882 * window of the controller but, there is not necessarily a flash
883 * module behind to handle the memory accesses. This depends on
884 * the board configuration.
886 for (i
= 0; i
< s
->ctrl
->max_slaves
; ++i
) {
887 AspeedSMCFlash
*fl
= &s
->flashes
[i
];
889 snprintf(name
, sizeof(name
), "%s.%d", s
->ctrl
->name
, i
);
893 fl
->size
= s
->ctrl
->segments
[i
].size
;
894 memory_region_init_io(&fl
->mmio
, OBJECT(s
), &aspeed_smc_flash_ops
,
896 memory_region_add_subregion(&s
->mmio_flash
, offset
, &fl
->mmio
);
901 static const VMStateDescription vmstate_aspeed_smc
= {
902 .name
= "aspeed.smc",
904 .minimum_version_id
= 2,
905 .fields
= (VMStateField
[]) {
906 VMSTATE_UINT32_ARRAY(regs
, AspeedSMCState
, ASPEED_SMC_R_MAX
),
907 VMSTATE_UINT8(snoop_index
, AspeedSMCState
),
908 VMSTATE_UINT8(snoop_dummies
, AspeedSMCState
),
909 VMSTATE_END_OF_LIST()
913 static Property aspeed_smc_properties
[] = {
914 DEFINE_PROP_UINT32("num-cs", AspeedSMCState
, num_cs
, 1),
915 DEFINE_PROP_END_OF_LIST(),
918 static void aspeed_smc_class_init(ObjectClass
*klass
, void *data
)
920 DeviceClass
*dc
= DEVICE_CLASS(klass
);
921 AspeedSMCClass
*mc
= ASPEED_SMC_CLASS(klass
);
923 dc
->realize
= aspeed_smc_realize
;
924 dc
->reset
= aspeed_smc_reset
;
925 dc
->props
= aspeed_smc_properties
;
926 dc
->vmsd
= &vmstate_aspeed_smc
;
930 static const TypeInfo aspeed_smc_info
= {
931 .name
= TYPE_ASPEED_SMC
,
932 .parent
= TYPE_SYS_BUS_DEVICE
,
933 .instance_size
= sizeof(AspeedSMCState
),
934 .class_size
= sizeof(AspeedSMCClass
),
938 static void aspeed_smc_register_types(void)
942 type_register_static(&aspeed_smc_info
);
943 for (i
= 0; i
< ARRAY_SIZE(controllers
); ++i
) {
945 .name
= controllers
[i
].name
,
946 .parent
= TYPE_ASPEED_SMC
,
947 .class_init
= aspeed_smc_class_init
,
948 .class_data
= (void *)&controllers
[i
],
954 type_init(aspeed_smc_register_types
)