xref: /openbmc/qemu/include/hw/ssi/aspeed_smc.h (revision 53ba2eee)
1 /*
2  * ASPEED AST2400 SMC Controller (SPI Flash Only)
3  *
4  * Copyright (C) 2016 IBM Corp.
5  *
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:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
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
22  * THE SOFTWARE.
23  */
24 
25 #ifndef ASPEED_SMC_H
26 #define ASPEED_SMC_H
27 
28 #include "hw/ssi/ssi.h"
29 #include "hw/sysbus.h"
30 #include "qom/object.h"
31 
32 typedef struct AspeedSegments {
33     hwaddr addr;
34     uint32_t size;
35 } AspeedSegments;
36 
37 struct AspeedSMCState;
38 typedef struct AspeedSMCController {
39     const char *name;
40     uint8_t r_conf;
41     uint8_t r_ce_ctrl;
42     uint8_t r_ctrl0;
43     uint8_t r_timings;
44     uint8_t nregs_timings;
45     uint8_t conf_enable_w0;
46     uint8_t max_slaves;
47     const AspeedSegments *segments;
48     hwaddr flash_window_base;
49     uint32_t flash_window_size;
50     bool has_dma;
51     hwaddr dma_flash_mask;
52     hwaddr dma_dram_mask;
53     uint32_t nregs;
54     uint32_t (*segment_to_reg)(const struct AspeedSMCState *s,
55                                const AspeedSegments *seg);
56     void (*reg_to_segment)(const struct AspeedSMCState *s, uint32_t reg,
57                            AspeedSegments *seg);
58 } AspeedSMCController;
59 
60 typedef struct AspeedSMCFlash {
61     struct AspeedSMCState *controller;
62 
63     uint8_t id;
64     uint32_t size;
65 
66     MemoryRegion mmio;
67     DeviceState *flash;
68 } AspeedSMCFlash;
69 
70 #define TYPE_ASPEED_SMC "aspeed.smc"
71 OBJECT_DECLARE_TYPE(AspeedSMCState, AspeedSMCClass, ASPEED_SMC)
72 
73 struct AspeedSMCClass {
74     SysBusDevice parent_obj;
75     const AspeedSMCController *ctrl;
76 };
77 
78 #define ASPEED_SMC_R_MAX        (0x100 / 4)
79 
80 struct AspeedSMCState {
81     SysBusDevice parent_obj;
82 
83     const AspeedSMCController *ctrl;
84 
85     MemoryRegion mmio;
86     MemoryRegion mmio_flash;
87 
88     qemu_irq irq;
89     int irqline;
90 
91     uint32_t num_cs;
92     qemu_irq *cs_lines;
93     bool inject_failure;
94 
95     SSIBus *spi;
96 
97     uint32_t regs[ASPEED_SMC_R_MAX];
98 
99     /* depends on the controller type */
100     uint8_t r_conf;
101     uint8_t r_ce_ctrl;
102     uint8_t r_ctrl0;
103     uint8_t r_timings;
104     uint8_t conf_enable_w0;
105 
106     /* for DMA support */
107     uint64_t sdram_base;
108 
109     AddressSpace flash_as;
110     MemoryRegion *dram_mr;
111     AddressSpace dram_as;
112 
113     AspeedSMCFlash *flashes;
114 
115     uint8_t snoop_index;
116     uint8_t snoop_dummies;
117 };
118 
119 #endif /* ASPEED_SMC_H */
120