xref: /openbmc/qemu/include/hw/ssi/aspeed_smc.h (revision ac12b601)
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_peripherals;
47     const AspeedSegments *segments;
48     hwaddr flash_window_base;
49     uint32_t flash_window_size;
50     uint32_t features;
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     void (*dma_ctrl)(struct AspeedSMCState *s, uint32_t value);
59 } AspeedSMCController;
60 
61 typedef struct AspeedSMCFlash {
62     struct AspeedSMCState *controller;
63 
64     uint8_t id;
65     uint32_t size;
66 
67     MemoryRegion mmio;
68     DeviceState *flash;
69 } AspeedSMCFlash;
70 
71 #define TYPE_ASPEED_SMC "aspeed.smc"
72 OBJECT_DECLARE_TYPE(AspeedSMCState, AspeedSMCClass, ASPEED_SMC)
73 
74 struct AspeedSMCClass {
75     SysBusDevice parent_obj;
76     const AspeedSMCController *ctrl;
77 };
78 
79 #define ASPEED_SMC_R_MAX        (0x100 / 4)
80 
81 struct AspeedSMCState {
82     SysBusDevice parent_obj;
83 
84     const AspeedSMCController *ctrl;
85 
86     MemoryRegion mmio;
87     MemoryRegion mmio_flash;
88     MemoryRegion mmio_flash_alias;
89 
90     qemu_irq irq;
91     int irqline;
92 
93     uint32_t num_cs;
94     qemu_irq *cs_lines;
95     bool inject_failure;
96 
97     SSIBus *spi;
98 
99     uint32_t regs[ASPEED_SMC_R_MAX];
100 
101     /* depends on the controller type */
102     uint8_t r_conf;
103     uint8_t r_ce_ctrl;
104     uint8_t r_ctrl0;
105     uint8_t r_timings;
106     uint8_t conf_enable_w0;
107 
108     AddressSpace flash_as;
109     MemoryRegion *dram_mr;
110     AddressSpace dram_as;
111 
112     AspeedSMCFlash *flashes;
113 
114     uint8_t snoop_index;
115     uint8_t snoop_dummies;
116 };
117 
118 #endif /* ASPEED_SMC_H */
119