blob: e70ac93fa5d6efd8b8ae1d76f5ac76f5a3a86322 [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
Ahmed Ghazy22d29d62020-10-28 03:42:02 +02006 parameter IOCONFIG = 8'h 20
shalan0d14e6e2020-08-31 16:50:48 +02007)(
8 input wb_clk_i,
9 input wb_rst_i,
10
11 input [31:0] wb_dat_i,
12 input [31:0] wb_adr_i,
13 input [3:0] wb_sel_i,
14 input wb_cyc_i,
15 input wb_stb_i,
16 input wb_we_i,
17
18 output [31:0] wb_dat_o,
19 output wb_ack_o,
20
Tim Edwards04ba17f2020-10-02 22:27:50 -040021 // Output is to serial loader
22 output serial_clock,
23 output serial_resetn,
24 output serial_data_out,
shalan0d14e6e2020-08-31 16:50:48 +020025
Tim Edwards496a08a2020-10-26 15:44:51 -040026 // Pass state of OEB bit on SDO and JTAG back to the core
27 // so that the function can be overridden for management output
28 output sdo_oenb_state,
29 output jtag_oenb_state,
30
Tim Edwards04ba17f2020-10-02 22:27:50 -040031 // Read/write data to each GPIO pad from management SoC
Ahmed Ghazy22d29d62020-10-28 03:42:02 +020032 input [`MPRJ_IO_PADS-1:0] mgmt_gpio_in,
33 output [`MPRJ_IO_PADS-1:0] mgmt_gpio_out,
Tim Edwardsba328902020-10-27 15:03:22 -040034
35 // Write data to power controls
Ahmed Ghazy22d29d62020-10-28 03:42:02 +020036 output [`MPRJ_PWR_PADS-1:0] pwr_ctrl_out
Tim Edwards04ba17f2020-10-02 22:27:50 -040037);
shalan0d14e6e2020-08-31 16:50:48 +020038 wire resetn;
39 wire valid;
40 wire ready;
41 wire [3:0] iomem_we;
42
43 assign resetn = ~wb_rst_i;
44 assign valid = wb_stb_i && wb_cyc_i;
45
46 assign iomem_we = wb_sel_i & {4{wb_we_i}};
47 assign wb_ack_o = ready;
48
49 mprj_ctrl #(
50 .BASE_ADR(BASE_ADR),
Tim Edwards04ba17f2020-10-02 22:27:50 -040051 .XFER(XFER),
Tim Edwardsba328902020-10-27 15:03:22 -040052 .PWRDATA(PWRDATA),
53 .IODATA(IODATA),
Ahmed Ghazy22d29d62020-10-28 03:42:02 +020054 .IOCONFIG(IOCONFIG)
shalan0d14e6e2020-08-31 16:50:48 +020055 ) mprj_ctrl (
56 .clk(wb_clk_i),
57 .resetn(resetn),
58 .iomem_addr(wb_adr_i),
59 .iomem_valid(valid),
Tim Edwardsc18c4742020-10-03 11:26:39 -040060 .iomem_wstrb(iomem_we[1:0]),
shalan0d14e6e2020-08-31 16:50:48 +020061 .iomem_wdata(wb_dat_i),
62 .iomem_rdata(wb_dat_o),
63 .iomem_ready(ready),
Tim Edwards04ba17f2020-10-02 22:27:50 -040064
65 .serial_clock(serial_clock),
66 .serial_resetn(serial_resetn),
67 .serial_data_out(serial_data_out),
Tim Edwards496a08a2020-10-26 15:44:51 -040068 .sdo_oenb_state(sdo_oenb_state),
69 .jtag_oenb_state(jtag_oenb_state),
Tim Edwards44bab472020-10-04 22:09:54 -040070 // .mgmt_gpio_io(mgmt_gpio_io)
71 .mgmt_gpio_in(mgmt_gpio_in),
Tim Edwardsca2f3182020-10-06 10:05:11 -040072 .mgmt_gpio_out(mgmt_gpio_out)
shalan0d14e6e2020-08-31 16:50:48 +020073 );
74
75endmodule
76
77module mprj_ctrl #(
Tim Edwardsba328902020-10-27 15:03:22 -040078 parameter BASE_ADR = 32'h 2300_0000,
79 parameter XFER = 8'h 00,
80 parameter PWRDATA = 8'h 04,
81 parameter IODATA = 8'h 08,
82 parameter IOCONFIG = 8'h 20,
Tim Edwardsba328902020-10-27 15:03:22 -040083 parameter IO_CTRL_BITS = 13
shalan0d14e6e2020-08-31 16:50:48 +020084)(
85 input clk,
86 input resetn,
87
88 input [31:0] iomem_addr,
89 input iomem_valid,
Tim Edwardsc18c4742020-10-03 11:26:39 -040090 input [1:0] iomem_wstrb,
shalan0d14e6e2020-08-31 16:50:48 +020091 input [31:0] iomem_wdata,
shalan0d14e6e2020-08-31 16:50:48 +020092 output reg [31:0] iomem_rdata,
93 output reg iomem_ready,
94
Tim Edwards04ba17f2020-10-02 22:27:50 -040095 output serial_clock,
96 output serial_resetn,
97 output serial_data_out,
Tim Edwards496a08a2020-10-26 15:44:51 -040098 output sdo_oenb_state,
99 output jtag_oenb_state,
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200100 input [`MPRJ_IO_PADS-1:0] mgmt_gpio_in,
101 output [`MPRJ_IO_PADS-1:0] mgmt_gpio_out
shalan0d14e6e2020-08-31 16:50:48 +0200102);
Tim Edwardsc18c4742020-10-03 11:26:39 -0400103
Tim Edwards44bab472020-10-04 22:09:54 -0400104`define IDLE 2'b00
105`define START 2'b01
106`define XBYTE 2'b10
107`define LOAD 2'b11
Tim Edwardsc18c4742020-10-03 11:26:39 -0400108
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200109 localparam IO_WORDS = (`MPRJ_IO_PADS % 32 != 0) + (`MPRJ_IO_PADS / 32);
Tim Edwards9eda80d2020-10-08 21:36:44 -0400110
Tim Edwardsba328902020-10-27 15:03:22 -0400111 localparam IO_BASE_ADR = (BASE_ADR | IOCONFIG);
112
Tim Edwards44bab472020-10-04 22:09:54 -0400113 localparam OEB = 1; // Offset of output enable in shift register.
114 localparam INP_DIS = 3; // Offset of input disable in shift register.
shalan0d14e6e2020-08-31 16:50:48 +0200115
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200116 reg [IO_CTRL_BITS-1:0] io_ctrl[`MPRJ_IO_PADS-1:0]; // I/O control, 1 word per gpio pad
117 reg [`MPRJ_IO_PADS-1:0] mgmt_gpio_outr; // I/O write data, 1 bit per gpio pad
118 wire [`MPRJ_IO_PADS-1:0] mgmt_gpio_out; // I/O write data output when input disabled
119 reg [`MPRJ_PWR_PADS-1:0] pwr_ctrl_out; // Power write data, 1 bit per power pad
Tim Edwardsba328902020-10-27 15:03:22 -0400120 reg xfer_ctrl; // Transfer control (1 bit)
shalan0d14e6e2020-08-31 16:50:48 +0200121
Tim Edwards9eda80d2020-10-08 21:36:44 -0400122 wire [IO_WORDS-1:0] io_data_sel; // wishbone selects
Tim Edwardsba328902020-10-27 15:03:22 -0400123 wire pwr_data_sel;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400124 wire xfer_sel;
Tim Edwardsd01c6372020-10-28 13:40:03 -0400125 wire busy;
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200126 wire [`MPRJ_IO_PADS-1:0] io_ctrl_sel;
Ahmed Ghazyf46273f2020-10-31 23:48:35 +0200127 reg [31:0] iomem_rdata_pre;
Tim Edwardsba328902020-10-27 15:03:22 -0400128
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200129 wire [`MPRJ_IO_PADS-1:0] mgmt_gpio_in;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400130
Tim Edwards496a08a2020-10-26 15:44:51 -0400131 wire sdo_oenb_state, jtag_oenb_state;
132
133 // JTAG and housekeeping SDO are normally controlled by their respective
134 // modules with OEB set to the default 1 value. If configured for an
135 // additional output by setting the OEB bit low, then pass this information
136 // back to the core so that the default signals can be overridden.
137
138 assign jtag_oenb_state = io_ctrl[0][OEB];
139 assign sdo_oenb_state = io_ctrl[1][OEB];
140
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200141 `define wtop (((i+1)*32 > `MPRJ_IO_PADS) ? `MPRJ_IO_PADS-1 : (i+1)*32-1)
Tim Edwards0445c082020-10-27 20:53:54 -0400142 `define wbot (i*32)
143 `define rtop (`wtop - `wbot)
Tim Edwards04ba17f2020-10-02 22:27:50 -0400144
shalan0d14e6e2020-08-31 16:50:48 +0200145 genvar i;
Tim Edwards9eda80d2020-10-08 21:36:44 -0400146
Tim Edwards0445c082020-10-27 20:53:54 -0400147 // Assign selection bits per address
148
149 assign xfer_sel = (iomem_addr[7:0] == XFER);
150 assign pwr_data_sel = (iomem_addr[7:0] == PWRDATA);
151
Tim Edwards9eda80d2020-10-08 21:36:44 -0400152 generate
153 for (i=0; i<IO_WORDS; i=i+1) begin
Tim Edwardsba328902020-10-27 15:03:22 -0400154 assign io_data_sel[i] = (iomem_addr[7:0] == (IODATA + i*4));
Tim Edwards9eda80d2020-10-08 21:36:44 -0400155 end
Tim Edwards9eda80d2020-10-08 21:36:44 -0400156
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200157 for (i=0; i<`MPRJ_IO_PADS; i=i+1) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400158 assign io_ctrl_sel[i] = (iomem_addr[7:0] == (IO_BASE_ADR[7:0] + i*4));
Tim Edwardsca2f3182020-10-06 10:05:11 -0400159 assign mgmt_gpio_out[i] = (io_ctrl[i][INP_DIS] == 1'b1) ?
160 mgmt_gpio_outr[i] : 1'bz;
shalan0d14e6e2020-08-31 16:50:48 +0200161 end
162 endgenerate
163
Tim Edwards0445c082020-10-27 20:53:54 -0400164 // Set selection and iomem_rdata_pre
165
166 assign selected = xfer_sel || pwr_data_sel || (|io_data_sel) || (|io_ctrl_sel);
167
Ahmed Ghazyf46273f2020-10-31 23:48:35 +0200168 wire [31:0] io_data_arr[0:IO_WORDS-1];
169 wire [31:0] io_ctrl_arr[0:`MPRJ_IO_PADS-1];
170 generate
171 for (i=0; i<IO_WORDS; i=i+1) begin
172 assign io_data_arr[i] = {{(31-`rtop){1'b0}}, mgmt_gpio_in[`wtop:`wbot]};
Tim Edwards0445c082020-10-27 20:53:54 -0400173
Ahmed Ghazyf46273f2020-10-31 23:48:35 +0200174 end
175 for (i=0; i<`MPRJ_IO_PADS; i=i+1) begin
176 assign io_ctrl_arr[i] = {{(32-IO_CTRL_BITS){1'b0}}, io_ctrl[i]};
177 end
Tim Edwards0445c082020-10-27 20:53:54 -0400178 endgenerate
179
Ahmed Ghazyf46273f2020-10-31 23:48:35 +0200180
181 integer j;
182 always @ * begin
183 iomem_rdata_pre = 'b0;
184 if (xfer_sel) begin
185 iomem_rdata_pre = {31'b0, busy};
186 end else if (pwr_data_sel) begin
187 iomem_rdata_pre = {{(32-`MPRJ_PWR_PADS){1'b0}}, pwr_ctrl_out};
188 end else if (|io_data_sel) begin
189 for (j=0; j<IO_WORDS; j=j+1) begin
190 if (io_data_sel[j]) begin
191 iomem_rdata_pre = io_data_arr[j];
192 end
193 end
194 end else begin
195 for (j=0; j<`MPRJ_IO_PADS; j=j+1) begin
196 if (io_ctrl_sel[j]) begin
197 iomem_rdata_pre = io_ctrl_arr[j];
198 end
199 end
200 end
201 end
202
Tim Edwards0445c082020-10-27 20:53:54 -0400203 // General I/O transfer
204
205 always @(posedge clk) begin
206 if (!resetn) begin
207 iomem_rdata <= 0;
208 iomem_ready <= 0;
209 end else begin
210 iomem_ready <= 0;
211 if (iomem_valid && !iomem_ready && iomem_addr[31:8] == BASE_ADR[31:8]) begin
212 iomem_ready <= 1'b 1;
213
214 if (selected) begin
215 iomem_rdata <= iomem_rdata_pre;
216 end
217 end
218 end
219 end
220
221 // I/O write of xfer bit. Also handles iomem_ready signal and power data.
Tim Edwards04ba17f2020-10-02 22:27:50 -0400222
223 always @(posedge clk) begin
224 if (!resetn) begin
225 xfer_ctrl <= 0;
Tim Edwardsba328902020-10-27 15:03:22 -0400226 pwr_ctrl_out <= 0;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400227 end else begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400228 if (iomem_valid && !iomem_ready && iomem_addr[31:8] == BASE_ADR[31:8]) begin
Tim Edwards9eda80d2020-10-08 21:36:44 -0400229 if (xfer_sel) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400230 if (iomem_wstrb[0]) xfer_ctrl <= iomem_wdata[0];
Tim Edwardsba328902020-10-27 15:03:22 -0400231 end else if (pwr_data_sel) begin
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200232 if (iomem_wstrb[0]) pwr_ctrl_out <= iomem_wdata[`MPRJ_PWR_PADS-1:0];
Tim Edwards04ba17f2020-10-02 22:27:50 -0400233 end
Tim Edwards251e0df2020-10-05 11:02:12 -0400234 end else begin
235 xfer_ctrl <= 1'b0; // Immediately self-resetting
Tim Edwards04ba17f2020-10-02 22:27:50 -0400236 end
237 end
238 end
239
Tim Edwards9eda80d2020-10-08 21:36:44 -0400240 // I/O transfer of gpio data to/from user project region under management
241 // SoC control
242
Tim Edwards9eda80d2020-10-08 21:36:44 -0400243 generate
244 for (i=0; i<IO_WORDS; i=i+1) begin
245 always @(posedge clk) begin
246 if (!resetn) begin
247 mgmt_gpio_outr[`wtop:`wbot] <= 'd0;
248 end else begin
249 if (iomem_valid && !iomem_ready && iomem_addr[31:8] ==
250 BASE_ADR[31:8]) begin
251 if (io_data_sel[i]) begin
Tim Edwards9eda80d2020-10-08 21:36:44 -0400252 if (iomem_wstrb[0]) begin
253 mgmt_gpio_outr[`wtop:`wbot] <= iomem_wdata[`rtop:0];
254 end
255 end
256 end
257 end
258 end
259 end
Tim Edwards9eda80d2020-10-08 21:36:44 -0400260
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200261 for (i=0; i<`MPRJ_IO_PADS; i=i+1) begin
shalan0d14e6e2020-08-31 16:50:48 +0200262 always @(posedge clk) begin
263 if (!resetn) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400264 // NOTE: This initialization must match the defaults passed
Tim Edwards496a08a2020-10-26 15:44:51 -0400265 // to the control blocks. Specifically, 0x1803 is for a
Tim Edwards251e0df2020-10-05 11:02:12 -0400266 // bidirectional pad, and 0x0403 is for a simple input pad
267 if (i < 2) begin
Tim Edwards496a08a2020-10-26 15:44:51 -0400268 io_ctrl[i] <= 'h1803;
Tim Edwards251e0df2020-10-05 11:02:12 -0400269 end else begin
270 io_ctrl[i] <= 'h0403;
271 end
shalan0d14e6e2020-08-31 16:50:48 +0200272 end else begin
Tim Edwardsba328902020-10-27 15:03:22 -0400273 if (iomem_valid && !iomem_ready &&
274 iomem_addr[31:8] == BASE_ADR[31:8]) begin
shalan0d14e6e2020-08-31 16:50:48 +0200275 if (io_ctrl_sel[i]) begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400276 // NOTE: Byte-wide write to io_ctrl is prohibited
shalan0d14e6e2020-08-31 16:50:48 +0200277 if (iomem_wstrb[0])
Tim Edwardsc18c4742020-10-03 11:26:39 -0400278 io_ctrl[i] <= iomem_wdata[IO_CTRL_BITS-1:0];
shalan0d14e6e2020-08-31 16:50:48 +0200279 end
280 end
281 end
282 end
283 end
284 endgenerate
285
Tim Edwards04ba17f2020-10-02 22:27:50 -0400286 reg [3:0] xfer_count;
287 reg [5:0] pad_count;
288 reg [1:0] xfer_state;
289 reg serial_clock;
290 reg serial_resetn;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400291
Tim Edwardsc18c4742020-10-03 11:26:39 -0400292 reg [IO_CTRL_BITS-1:0] serial_data_staging;
293
Tim Edwards251e0df2020-10-05 11:02:12 -0400294 wire serial_data_out;
Tim Edwards251e0df2020-10-05 11:02:12 -0400295
296 assign serial_data_out = serial_data_staging[IO_CTRL_BITS-1];
297 assign busy = (xfer_state != `IDLE);
298
Tim Edwardsc18c4742020-10-03 11:26:39 -0400299 always @(posedge clk or negedge resetn) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400300 if (resetn == 1'b0) begin
301
Tim Edwards44bab472020-10-04 22:09:54 -0400302 xfer_state <= `IDLE;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400303 xfer_count <= 4'd0;
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200304 pad_count <= `MPRJ_IO_PADS;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400305 serial_resetn <= 1'b0;
306 serial_clock <= 1'b0;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400307
308 end else begin
309
Tim Edwards44bab472020-10-04 22:09:54 -0400310 if (xfer_state == `IDLE) begin
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200311 pad_count <= `MPRJ_IO_PADS;
Tim Edwards251e0df2020-10-05 11:02:12 -0400312 serial_resetn <= 1'b1;
Tim Edwards44bab472020-10-04 22:09:54 -0400313 serial_clock <= 1'b0;
314 if (xfer_ctrl == 1'b1) begin
315 xfer_state <= `START;
316 end
317 end else if (xfer_state == `START) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400318 serial_resetn <= 1'b1;
319 serial_clock <= 1'b0;
320 xfer_count <= 6'd0;
Tim Edwards251e0df2020-10-05 11:02:12 -0400321 pad_count <= pad_count - 1;
322 xfer_state <= `XBYTE;
323 serial_data_staging <= io_ctrl[pad_count - 1];
Tim Edwards04ba17f2020-10-02 22:27:50 -0400324 end else if (xfer_state == `XBYTE) begin
325 serial_resetn <= 1'b1;
326 serial_clock <= ~serial_clock;
327 if (serial_clock == 1'b0) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400328 if (xfer_count == IO_CTRL_BITS - 1) begin
329 if (pad_count == 0) begin
330 xfer_state <= `LOAD;
331 end else begin
332 xfer_state <= `START;
333 end
Tim Edwards04ba17f2020-10-02 22:27:50 -0400334 end else begin
335 xfer_count <= xfer_count + 1;
336 end
337 end else begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400338 serial_data_staging <= {serial_data_staging[IO_CTRL_BITS-2:0], 1'b0};
Tim Edwards04ba17f2020-10-02 22:27:50 -0400339 end
340 end else if (xfer_state == `LOAD) begin
341 xfer_count <= xfer_count + 1;
342
343 /* Load sequence: Raise clock for final data shift in;
344 * Pulse reset low while clock is high
345 * Set clock back to zero.
346 * Return to idle mode.
347 */
348 if (xfer_count == 4'd0) begin
349 serial_clock <= 1'b1;
350 serial_resetn <= 1'b1;
351 end else if (xfer_count == 4'd1) begin
352 serial_clock <= 1'b1;
353 serial_resetn <= 1'b0;
354 end else if (xfer_count == 4'd2) begin
355 serial_clock <= 1'b1;
356 serial_resetn <= 1'b1;
357 end else if (xfer_count == 4'd3) begin
358 serial_resetn <= 1'b1;
359 serial_clock <= 1'b0;
Tim Edwards44bab472020-10-04 22:09:54 -0400360 xfer_state <= `IDLE;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400361 end
362 end
363 end
364 end
365
366endmodule