blob: e0a468349bf72fc4ea08217414ee6a2221620203 [file] [log] [blame]
shalan0d14e6e2020-08-31 16:50:48 +02001module mprj_ctrl_wb #(
Tim Edwardsba328902020-10-27 15:03:22 -04002 parameter BASE_ADR = 32'h 2300_0000,
3 parameter XFER = 8'h 00,
4 parameter PWRDATA = 8'h 04,
5 parameter IODATA = 8'h 08, // One word per 32 IOs
6 parameter IOCONFIG = 8'h 20,
7 parameter IO_PADS = 32, // Number of IO control registers (may be > 32)
8 parameter PWR_PADS = 32 // Number of power control registers (always < 32)
shalan0d14e6e2020-08-31 16:50:48 +02009)(
10 input wb_clk_i,
11 input wb_rst_i,
12
13 input [31:0] wb_dat_i,
14 input [31:0] wb_adr_i,
15 input [3:0] wb_sel_i,
16 input wb_cyc_i,
17 input wb_stb_i,
18 input wb_we_i,
19
20 output [31:0] wb_dat_o,
21 output wb_ack_o,
22
Tim Edwards04ba17f2020-10-02 22:27:50 -040023 // Output is to serial loader
24 output serial_clock,
25 output serial_resetn,
26 output serial_data_out,
shalan0d14e6e2020-08-31 16:50:48 +020027
Tim Edwards496a08a2020-10-26 15:44:51 -040028 // Pass state of OEB bit on SDO and JTAG back to the core
29 // so that the function can be overridden for management output
30 output sdo_oenb_state,
31 output jtag_oenb_state,
32
Tim Edwards04ba17f2020-10-02 22:27:50 -040033 // Read/write data to each GPIO pad from management SoC
Tim Edwards44bab472020-10-04 22:09:54 -040034 input [IO_PADS-1:0] mgmt_gpio_in,
Tim Edwardsba328902020-10-27 15:03:22 -040035 output [IO_PADS-1:0] mgmt_gpio_out,
36
37 // Write data to power controls
38 output [PWR_PADS-1:0] pwr_ctrl_out
Tim Edwards04ba17f2020-10-02 22:27:50 -040039);
shalan0d14e6e2020-08-31 16:50:48 +020040 wire resetn;
41 wire valid;
42 wire ready;
43 wire [3:0] iomem_we;
44
45 assign resetn = ~wb_rst_i;
46 assign valid = wb_stb_i && wb_cyc_i;
47
48 assign iomem_we = wb_sel_i & {4{wb_we_i}};
49 assign wb_ack_o = ready;
50
51 mprj_ctrl #(
52 .BASE_ADR(BASE_ADR),
Tim Edwards04ba17f2020-10-02 22:27:50 -040053 .XFER(XFER),
Tim Edwardsba328902020-10-27 15:03:22 -040054 .PWRDATA(PWRDATA),
55 .IODATA(IODATA),
56 .IOCONFIG(IOCONFIG),
Tim Edwards04ba17f2020-10-02 22:27:50 -040057 .IO_PADS(IO_PADS),
Tim Edwardsc18c4742020-10-03 11:26:39 -040058 .PWR_PADS(PWR_PADS)
shalan0d14e6e2020-08-31 16:50:48 +020059 ) mprj_ctrl (
60 .clk(wb_clk_i),
61 .resetn(resetn),
62 .iomem_addr(wb_adr_i),
63 .iomem_valid(valid),
Tim Edwardsc18c4742020-10-03 11:26:39 -040064 .iomem_wstrb(iomem_we[1:0]),
shalan0d14e6e2020-08-31 16:50:48 +020065 .iomem_wdata(wb_dat_i),
66 .iomem_rdata(wb_dat_o),
67 .iomem_ready(ready),
Tim Edwards04ba17f2020-10-02 22:27:50 -040068
69 .serial_clock(serial_clock),
70 .serial_resetn(serial_resetn),
71 .serial_data_out(serial_data_out),
Tim Edwards496a08a2020-10-26 15:44:51 -040072 .sdo_oenb_state(sdo_oenb_state),
73 .jtag_oenb_state(jtag_oenb_state),
Tim Edwards44bab472020-10-04 22:09:54 -040074 // .mgmt_gpio_io(mgmt_gpio_io)
75 .mgmt_gpio_in(mgmt_gpio_in),
Tim Edwardsca2f3182020-10-06 10:05:11 -040076 .mgmt_gpio_out(mgmt_gpio_out)
shalan0d14e6e2020-08-31 16:50:48 +020077 );
78
79endmodule
80
81module mprj_ctrl #(
Tim Edwardsba328902020-10-27 15:03:22 -040082 parameter BASE_ADR = 32'h 2300_0000,
83 parameter XFER = 8'h 00,
84 parameter PWRDATA = 8'h 04,
85 parameter IODATA = 8'h 08,
86 parameter IOCONFIG = 8'h 20,
87 parameter IO_PADS = 32,
88 parameter PWR_PADS = 32,
89 parameter IO_CTRL_BITS = 13
shalan0d14e6e2020-08-31 16:50:48 +020090)(
91 input clk,
92 input resetn,
93
94 input [31:0] iomem_addr,
95 input iomem_valid,
Tim Edwardsc18c4742020-10-03 11:26:39 -040096 input [1:0] iomem_wstrb,
shalan0d14e6e2020-08-31 16:50:48 +020097 input [31:0] iomem_wdata,
shalan0d14e6e2020-08-31 16:50:48 +020098 output reg [31:0] iomem_rdata,
99 output reg iomem_ready,
100
Tim Edwards04ba17f2020-10-02 22:27:50 -0400101 output serial_clock,
102 output serial_resetn,
103 output serial_data_out,
Tim Edwards496a08a2020-10-26 15:44:51 -0400104 output sdo_oenb_state,
105 output jtag_oenb_state,
Tim Edwards44bab472020-10-04 22:09:54 -0400106 input [IO_PADS-1:0] mgmt_gpio_in,
Tim Edwardsca2f3182020-10-06 10:05:11 -0400107 output [IO_PADS-1:0] mgmt_gpio_out
shalan0d14e6e2020-08-31 16:50:48 +0200108);
Tim Edwardsc18c4742020-10-03 11:26:39 -0400109
Tim Edwards44bab472020-10-04 22:09:54 -0400110`define IDLE 2'b00
111`define START 2'b01
112`define XBYTE 2'b10
113`define LOAD 2'b11
Tim Edwardsc18c4742020-10-03 11:26:39 -0400114
Ahmed Ghazy0b6219d2020-10-26 15:43:57 +0200115 localparam IO_WORDS = (IO_PADS % 32 != 0) + (IO_PADS / 32);
Tim Edwards9eda80d2020-10-08 21:36:44 -0400116
Tim Edwardsba328902020-10-27 15:03:22 -0400117 localparam IO_BASE_ADR = (BASE_ADR | IOCONFIG);
118
Tim Edwards44bab472020-10-04 22:09:54 -0400119 localparam OEB = 1; // Offset of output enable in shift register.
120 localparam INP_DIS = 3; // Offset of input disable in shift register.
shalan0d14e6e2020-08-31 16:50:48 +0200121
Tim Edwardsba328902020-10-27 15:03:22 -0400122 reg [IO_CTRL_BITS-1:0] io_ctrl[IO_PADS-1:0]; // I/O control, 1 word per gpio pad
123 reg [IO_PADS-1:0] mgmt_gpio_outr; // I/O write data, 1 bit per gpio pad
Tim Edwardsca2f3182020-10-06 10:05:11 -0400124 wire [IO_PADS-1:0] mgmt_gpio_out; // I/O write data output when input disabled
Tim Edwardsba328902020-10-27 15:03:22 -0400125 reg [PWR_PADS-1:0] pwr_ctrl_out; // Power write data, 1 bit per power pad
126 reg xfer_ctrl; // Transfer control (1 bit)
shalan0d14e6e2020-08-31 16:50:48 +0200127
Tim Edwards9eda80d2020-10-08 21:36:44 -0400128 wire [IO_WORDS-1:0] io_data_sel; // wishbone selects
Tim Edwardsba328902020-10-27 15:03:22 -0400129 wire pwr_data_sel;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400130 wire xfer_sel;
Tim Edwards9eda80d2020-10-08 21:36:44 -0400131 wire [IO_PADS-1:0] io_ctrl_sel;
Tim Edwardsba328902020-10-27 15:03:22 -0400132
Tim Edwards44bab472020-10-04 22:09:54 -0400133 wire [IO_PADS-1:0] mgmt_gpio_in;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400134
Tim Edwards496a08a2020-10-26 15:44:51 -0400135 wire sdo_oenb_state, jtag_oenb_state;
136
137 // JTAG and housekeeping SDO are normally controlled by their respective
138 // modules with OEB set to the default 1 value. If configured for an
139 // additional output by setting the OEB bit low, then pass this information
140 // back to the core so that the default signals can be overridden.
141
142 assign jtag_oenb_state = io_ctrl[0][OEB];
143 assign sdo_oenb_state = io_ctrl[1][OEB];
144
Tim Edwardsba328902020-10-27 15:03:22 -0400145 assign xfer_sel = (iomem_addr[7:0] == XFER);
146 assign pwr_data_sel = (iomem_addr[7:0] == PWRDATA);
Tim Edwards04ba17f2020-10-02 22:27:50 -0400147
shalan0d14e6e2020-08-31 16:50:48 +0200148 genvar i;
Tim Edwards9eda80d2020-10-08 21:36:44 -0400149
150 generate
151 for (i=0; i<IO_WORDS; i=i+1) begin
Tim Edwardsba328902020-10-27 15:03:22 -0400152 assign io_data_sel[i] = (iomem_addr[7:0] == (IODATA + i*4));
Tim Edwards9eda80d2020-10-08 21:36:44 -0400153 end
Tim Edwards9eda80d2020-10-08 21:36:44 -0400154
shalan0d14e6e2020-08-31 16:50:48 +0200155 for (i=0; i<IO_PADS; i=i+1) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400156 assign io_ctrl_sel[i] = (iomem_addr[7:0] == (IO_BASE_ADR[7:0] + i*4));
Tim Edwardsca2f3182020-10-06 10:05:11 -0400157 assign mgmt_gpio_out[i] = (io_ctrl[i][INP_DIS] == 1'b1) ?
158 mgmt_gpio_outr[i] : 1'bz;
shalan0d14e6e2020-08-31 16:50:48 +0200159 end
160 endgenerate
161
Tim Edwardsba328902020-10-27 15:03:22 -0400162 // I/O transfer of xfer bit. Also handles iomem_ready signal and power data.
Tim Edwards04ba17f2020-10-02 22:27:50 -0400163
164 always @(posedge clk) begin
165 if (!resetn) begin
166 xfer_ctrl <= 0;
Tim Edwardsba328902020-10-27 15:03:22 -0400167 pwr_ctrl_out <= 0;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400168 end else begin
169 iomem_ready <= 0;
Tim Edwardsc18c4742020-10-03 11:26:39 -0400170 if (iomem_valid && !iomem_ready && iomem_addr[31:8] == BASE_ADR[31:8]) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400171 iomem_ready <= 1'b 1;
172
Tim Edwards9eda80d2020-10-08 21:36:44 -0400173 if (xfer_sel) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400174 iomem_rdata <= {31'd0, busy};
175 if (iomem_wstrb[0]) xfer_ctrl <= iomem_wdata[0];
Tim Edwardsba328902020-10-27 15:03:22 -0400176 end else if (pwr_data_sel) begin
177 iomem_rdata <= pwr_ctrl_out;
178 if (iomem_wstrb[0]) pwr_ctrl_out <= iomem_wdata[PWR_PADS-1:0];
Tim Edwards04ba17f2020-10-02 22:27:50 -0400179 end
Tim Edwards251e0df2020-10-05 11:02:12 -0400180 end else begin
181 xfer_ctrl <= 1'b0; // Immediately self-resetting
Tim Edwards04ba17f2020-10-02 22:27:50 -0400182 end
183 end
184 end
185
Tim Edwards9eda80d2020-10-08 21:36:44 -0400186 // I/O transfer of gpio data to/from user project region under management
187 // SoC control
188
189 `define wtop (((i+1)*32 > IO_PADS) ? IO_PADS-1 : (i+1)*32-1)
190 `define wbot (i*32)
Ahmed Ghazy0b6219d2020-10-26 15:43:57 +0200191 `define rtop (`wtop - `wbot)
Tim Edwards9eda80d2020-10-08 21:36:44 -0400192
193 generate
194 for (i=0; i<IO_WORDS; i=i+1) begin
195 always @(posedge clk) begin
196 if (!resetn) begin
197 mgmt_gpio_outr[`wtop:`wbot] <= 'd0;
198 end else begin
199 if (iomem_valid && !iomem_ready && iomem_addr[31:8] ==
200 BASE_ADR[31:8]) begin
201 if (io_data_sel[i]) begin
Tim Edwardsba328902020-10-27 15:03:22 -0400202 iomem_rdata <= mgmt_gpio_in[`wtop:`wbot];
Tim Edwards9eda80d2020-10-08 21:36:44 -0400203 if (iomem_wstrb[0]) begin
204 mgmt_gpio_outr[`wtop:`wbot] <= iomem_wdata[`rtop:0];
205 end
206 end
207 end
208 end
209 end
210 end
Tim Edwards9eda80d2020-10-08 21:36:44 -0400211
shalan0d14e6e2020-08-31 16:50:48 +0200212 for (i=0; i<IO_PADS; i=i+1) begin
213 always @(posedge clk) begin
214 if (!resetn) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400215 // NOTE: This initialization must match the defaults passed
Tim Edwards496a08a2020-10-26 15:44:51 -0400216 // to the control blocks. Specifically, 0x1803 is for a
Tim Edwards251e0df2020-10-05 11:02:12 -0400217 // bidirectional pad, and 0x0403 is for a simple input pad
218 if (i < 2) begin
Tim Edwards496a08a2020-10-26 15:44:51 -0400219 io_ctrl[i] <= 'h1803;
Tim Edwards251e0df2020-10-05 11:02:12 -0400220 end else begin
221 io_ctrl[i] <= 'h0403;
222 end
shalan0d14e6e2020-08-31 16:50:48 +0200223 end else begin
Tim Edwardsba328902020-10-27 15:03:22 -0400224 if (iomem_valid && !iomem_ready &&
225 iomem_addr[31:8] == BASE_ADR[31:8]) begin
shalan0d14e6e2020-08-31 16:50:48 +0200226 if (io_ctrl_sel[i]) begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400227 iomem_rdata <= io_ctrl[i];
228 // NOTE: Byte-wide write to io_ctrl is prohibited
shalan0d14e6e2020-08-31 16:50:48 +0200229 if (iomem_wstrb[0])
Tim Edwardsc18c4742020-10-03 11:26:39 -0400230 io_ctrl[i] <= iomem_wdata[IO_CTRL_BITS-1:0];
shalan0d14e6e2020-08-31 16:50:48 +0200231 end
232 end
233 end
234 end
235 end
236 endgenerate
237
Tim Edwards04ba17f2020-10-02 22:27:50 -0400238 reg [3:0] xfer_count;
239 reg [5:0] pad_count;
240 reg [1:0] xfer_state;
241 reg serial_clock;
242 reg serial_resetn;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400243
Tim Edwardsc18c4742020-10-03 11:26:39 -0400244 // NOTE: Ignoring power control bits for now. . . need to revisit.
245 // Depends on how the power pads are arranged among the GPIO, and
246 // whether or not switching will be internal and under the control
247 // of the SoC.
Tim Edwards04ba17f2020-10-02 22:27:50 -0400248
Tim Edwardsc18c4742020-10-03 11:26:39 -0400249 reg [IO_CTRL_BITS-1:0] serial_data_staging;
250
Tim Edwards251e0df2020-10-05 11:02:12 -0400251 wire serial_data_out;
252 wire busy;
253
254 assign serial_data_out = serial_data_staging[IO_CTRL_BITS-1];
255 assign busy = (xfer_state != `IDLE);
256
Tim Edwardsc18c4742020-10-03 11:26:39 -0400257 always @(posedge clk or negedge resetn) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400258 if (resetn == 1'b0) begin
259
Tim Edwards44bab472020-10-04 22:09:54 -0400260 xfer_state <= `IDLE;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400261 xfer_count <= 4'd0;
Tim Edwards251e0df2020-10-05 11:02:12 -0400262 pad_count <= IO_PADS;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400263 serial_resetn <= 1'b0;
264 serial_clock <= 1'b0;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400265
266 end else begin
267
Tim Edwards44bab472020-10-04 22:09:54 -0400268 if (xfer_state == `IDLE) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400269 pad_count <= IO_PADS;
270 serial_resetn <= 1'b1;
Tim Edwards44bab472020-10-04 22:09:54 -0400271 serial_clock <= 1'b0;
272 if (xfer_ctrl == 1'b1) begin
273 xfer_state <= `START;
274 end
275 end else if (xfer_state == `START) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400276 serial_resetn <= 1'b1;
277 serial_clock <= 1'b0;
278 xfer_count <= 6'd0;
Tim Edwards251e0df2020-10-05 11:02:12 -0400279 pad_count <= pad_count - 1;
280 xfer_state <= `XBYTE;
281 serial_data_staging <= io_ctrl[pad_count - 1];
Tim Edwards04ba17f2020-10-02 22:27:50 -0400282 end else if (xfer_state == `XBYTE) begin
283 serial_resetn <= 1'b1;
284 serial_clock <= ~serial_clock;
285 if (serial_clock == 1'b0) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400286 if (xfer_count == IO_CTRL_BITS - 1) begin
287 if (pad_count == 0) begin
288 xfer_state <= `LOAD;
289 end else begin
290 xfer_state <= `START;
291 end
Tim Edwards04ba17f2020-10-02 22:27:50 -0400292 end else begin
293 xfer_count <= xfer_count + 1;
294 end
295 end else begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400296 serial_data_staging <= {serial_data_staging[IO_CTRL_BITS-2:0], 1'b0};
Tim Edwards04ba17f2020-10-02 22:27:50 -0400297 end
298 end else if (xfer_state == `LOAD) begin
299 xfer_count <= xfer_count + 1;
300
301 /* Load sequence: Raise clock for final data shift in;
302 * Pulse reset low while clock is high
303 * Set clock back to zero.
304 * Return to idle mode.
305 */
306 if (xfer_count == 4'd0) begin
307 serial_clock <= 1'b1;
308 serial_resetn <= 1'b1;
309 end else if (xfer_count == 4'd1) begin
310 serial_clock <= 1'b1;
311 serial_resetn <= 1'b0;
312 end else if (xfer_count == 4'd2) begin
313 serial_clock <= 1'b1;
314 serial_resetn <= 1'b1;
315 end else if (xfer_count == 4'd3) begin
316 serial_resetn <= 1'b1;
317 serial_clock <= 1'b0;
Tim Edwards44bab472020-10-04 22:09:54 -0400318 xfer_state <= `IDLE;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400319 end
320 end
321 end
322 end
323
324endmodule