blob: 117fcfea5de789cc35ef370950fdd2541adb1fe9 [file] [log] [blame]
shalan0d14e6e2020-08-31 16:50:48 +02001module mprj_ctrl_wb #(
2 parameter BASE_ADR = 32'h 2300_0000,
Tim Edwards04ba17f2020-10-02 22:27:50 -04003 parameter DATA = 8'h 00,
4 parameter XFER = 8'h 04,
5 parameter CONFIG = 8'h 08,
shalan0d14e6e2020-08-31 16:50:48 +02006 parameter IO_PADS = 32, // Number of IO control registers
Tim Edwardsc18c4742020-10-03 11:26:39 -04007 parameter PWR_PADS = 32 // Number of power control registers
shalan0d14e6e2020-08-31 16:50:48 +02008)(
9 input wb_clk_i,
10 input wb_rst_i,
11
12 input [31:0] wb_dat_i,
13 input [31:0] wb_adr_i,
14 input [3:0] wb_sel_i,
15 input wb_cyc_i,
16 input wb_stb_i,
17 input wb_we_i,
18
19 output [31:0] wb_dat_o,
20 output wb_ack_o,
21
Tim Edwards04ba17f2020-10-02 22:27:50 -040022 // Output is to serial loader
23 output serial_clock,
24 output serial_resetn,
25 output serial_data_out,
shalan0d14e6e2020-08-31 16:50:48 +020026
Tim Edwards04ba17f2020-10-02 22:27:50 -040027 // Read/write data to each GPIO pad from management SoC
Tim Edwards44bab472020-10-04 22:09:54 -040028 input [IO_PADS-1:0] mgmt_gpio_in,
Tim Edwardsca2f3182020-10-06 10:05:11 -040029 output [IO_PADS-1:0] mgmt_gpio_out
Tim Edwards04ba17f2020-10-02 22:27:50 -040030);
shalan0d14e6e2020-08-31 16:50:48 +020031 wire resetn;
32 wire valid;
33 wire ready;
34 wire [3:0] iomem_we;
35
36 assign resetn = ~wb_rst_i;
37 assign valid = wb_stb_i && wb_cyc_i;
38
39 assign iomem_we = wb_sel_i & {4{wb_we_i}};
40 assign wb_ack_o = ready;
41
42 mprj_ctrl #(
43 .BASE_ADR(BASE_ADR),
Tim Edwards04ba17f2020-10-02 22:27:50 -040044 .DATA(DATA),
45 .CONFIG(CONFIG),
46 .XFER(XFER),
47 .IO_PADS(IO_PADS),
Tim Edwardsc18c4742020-10-03 11:26:39 -040048 .PWR_PADS(PWR_PADS)
shalan0d14e6e2020-08-31 16:50:48 +020049 ) mprj_ctrl (
50 .clk(wb_clk_i),
51 .resetn(resetn),
52 .iomem_addr(wb_adr_i),
53 .iomem_valid(valid),
Tim Edwardsc18c4742020-10-03 11:26:39 -040054 .iomem_wstrb(iomem_we[1:0]),
shalan0d14e6e2020-08-31 16:50:48 +020055 .iomem_wdata(wb_dat_i),
56 .iomem_rdata(wb_dat_o),
57 .iomem_ready(ready),
Tim Edwards04ba17f2020-10-02 22:27:50 -040058
59 .serial_clock(serial_clock),
60 .serial_resetn(serial_resetn),
61 .serial_data_out(serial_data_out),
Tim Edwards44bab472020-10-04 22:09:54 -040062 // .mgmt_gpio_io(mgmt_gpio_io)
63 .mgmt_gpio_in(mgmt_gpio_in),
Tim Edwardsca2f3182020-10-06 10:05:11 -040064 .mgmt_gpio_out(mgmt_gpio_out)
shalan0d14e6e2020-08-31 16:50:48 +020065 );
66
67endmodule
68
69module mprj_ctrl #(
70 parameter BASE_ADR = 32'h 2300_0000,
Tim Edwards04ba17f2020-10-02 22:27:50 -040071 parameter DATA = 8'h 00,
72 parameter XFER = 8'h 04,
73 parameter CONFIG = 8'h 08,
shalan0d14e6e2020-08-31 16:50:48 +020074 parameter IO_PADS = 32,
Tim Edwardsc18c4742020-10-03 11:26:39 -040075 parameter PWR_PADS = 32,
Tim Edwards44bab472020-10-04 22:09:54 -040076 parameter IO_CTRL_BITS = 13,
Tim Edwardsc18c4742020-10-03 11:26:39 -040077 parameter PWR_CTRL_BITS = 1
shalan0d14e6e2020-08-31 16:50:48 +020078)(
79 input clk,
80 input resetn,
81
82 input [31:0] iomem_addr,
83 input iomem_valid,
Tim Edwardsc18c4742020-10-03 11:26:39 -040084 input [1:0] iomem_wstrb,
shalan0d14e6e2020-08-31 16:50:48 +020085 input [31:0] iomem_wdata,
shalan0d14e6e2020-08-31 16:50:48 +020086 output reg [31:0] iomem_rdata,
87 output reg iomem_ready,
88
Tim Edwards04ba17f2020-10-02 22:27:50 -040089 output serial_clock,
90 output serial_resetn,
91 output serial_data_out,
Tim Edwards44bab472020-10-04 22:09:54 -040092 input [IO_PADS-1:0] mgmt_gpio_in,
Tim Edwardsca2f3182020-10-06 10:05:11 -040093 output [IO_PADS-1:0] mgmt_gpio_out
shalan0d14e6e2020-08-31 16:50:48 +020094);
Tim Edwardsc18c4742020-10-03 11:26:39 -040095
Tim Edwards44bab472020-10-04 22:09:54 -040096`define IDLE 2'b00
97`define START 2'b01
98`define XBYTE 2'b10
99`define LOAD 2'b11
Tim Edwardsc18c4742020-10-03 11:26:39 -0400100
Tim Edwards04ba17f2020-10-02 22:27:50 -0400101 localparam IO_BASE_ADR = (BASE_ADR | CONFIG);
102 localparam PWR_BASE_ADR = (BASE_ADR | CONFIG) + IO_PADS*4;
Tim Edwards44bab472020-10-04 22:09:54 -0400103 localparam OEB = 1; // Offset of output enable in shift register.
104 localparam INP_DIS = 3; // Offset of input disable in shift register.
shalan0d14e6e2020-08-31 16:50:48 +0200105
Tim Edwards89f09242020-10-05 15:17:34 -0400106 reg [IO_CTRL_BITS-1:0] io_ctrl[IO_PADS-1:0]; // I/O control, 1 word per gpio pad
107 reg [PWR_CTRL_BITS-1:0] pwr_ctrl[PWR_PADS-1:0]; // Power control, 1 word per power pad
Tim Edwardsca2f3182020-10-06 10:05:11 -0400108 reg [IO_PADS-1:0] mgmt_gpio_outr; // I/O write data, 1 bit per gpio pad
109 wire [IO_PADS-1:0] mgmt_gpio_out; // I/O write data output when input disabled
Tim Edwards04ba17f2020-10-02 22:27:50 -0400110 reg xfer_ctrl; // Transfer control (1 bit)
shalan0d14e6e2020-08-31 16:50:48 +0200111
Tim Edwards04ba17f2020-10-02 22:27:50 -0400112 wire [IO_PADS-1:0] io_ctrl_sel; // wishbone selects
Tim Edwardsc18c4742020-10-03 11:26:39 -0400113 wire [PWR_PADS-1:0] pwr_ctrl_sel;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400114 wire io_data_sel;
115 wire xfer_sel;
Tim Edwards44bab472020-10-04 22:09:54 -0400116 wire [IO_PADS-1:0] mgmt_gpio_in;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400117
118 assign xfer_sel = (iomem_addr[7:0] == XFER);
119 assign io_data_sel = (iomem_addr[7:0] == DATA);
120
shalan0d14e6e2020-08-31 16:50:48 +0200121 genvar i;
122 generate
123 for (i=0; i<IO_PADS; i=i+1) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400124 assign io_ctrl_sel[i] = (iomem_addr[7:0] == (IO_BASE_ADR[7:0] + i*4));
Tim Edwardsca2f3182020-10-06 10:05:11 -0400125 assign mgmt_gpio_out[i] = (io_ctrl[i][INP_DIS] == 1'b1) ?
126 mgmt_gpio_outr[i] : 1'bz;
shalan0d14e6e2020-08-31 16:50:48 +0200127 end
128 endgenerate
129
130 generate
Tim Edwardsc18c4742020-10-03 11:26:39 -0400131 for (i=0; i<PWR_PADS; i=i+1) begin
shalan0d14e6e2020-08-31 16:50:48 +0200132 assign pwr_ctrl_sel[i] = (iomem_addr[7:0] == (PWR_BASE_ADR[7:0] + i*4));
133 end
134 endgenerate
135
Tim Edwards04ba17f2020-10-02 22:27:50 -0400136 // I/O transfer of xfer bit and gpio data to/from user project region under
137 // management SoC control
138
139 always @(posedge clk) begin
140 if (!resetn) begin
141 xfer_ctrl <= 0;
Tim Edwardsca2f3182020-10-06 10:05:11 -0400142 mgmt_gpio_outr <= 'd0;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400143 end else begin
144 iomem_ready <= 0;
Tim Edwardsc18c4742020-10-03 11:26:39 -0400145 if (iomem_valid && !iomem_ready && iomem_addr[31:8] == BASE_ADR[31:8]) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400146 iomem_ready <= 1'b 1;
147
148 if (io_data_sel) begin
149 iomem_rdata <= mgmt_gpio_in;
Tim Edwards44bab472020-10-04 22:09:54 -0400150 if (iomem_wstrb[0]) begin
Tim Edwardsca2f3182020-10-06 10:05:11 -0400151 mgmt_gpio_outr[IO_PADS-1:0] <= iomem_wdata[IO_PADS-1:0];
Tim Edwards44bab472020-10-04 22:09:54 -0400152 end
Tim Edwards04ba17f2020-10-02 22:27:50 -0400153
154 end else if (xfer_sel) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400155 iomem_rdata <= {31'd0, busy};
156 if (iomem_wstrb[0]) xfer_ctrl <= iomem_wdata[0];
Tim Edwards04ba17f2020-10-02 22:27:50 -0400157 end
Tim Edwards251e0df2020-10-05 11:02:12 -0400158 end else begin
159 xfer_ctrl <= 1'b0; // Immediately self-resetting
Tim Edwards04ba17f2020-10-02 22:27:50 -0400160 end
161 end
162 end
163
shalan0d14e6e2020-08-31 16:50:48 +0200164 generate
165 for (i=0; i<IO_PADS; i=i+1) begin
166 always @(posedge clk) begin
167 if (!resetn) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400168 // NOTE: This initialization must match the defaults passed
169 // to the control blocks. Specifically, 0x1801 is for a
170 // bidirectional pad, and 0x0403 is for a simple input pad
171 if (i < 2) begin
172 io_ctrl[i] <= 'h1801;
173 end else begin
174 io_ctrl[i] <= 'h0403;
175 end
shalan0d14e6e2020-08-31 16:50:48 +0200176 end else begin
shalan0d14e6e2020-08-31 16:50:48 +0200177 if (iomem_valid && !iomem_ready && iomem_addr[31:8] == BASE_ADR[31:8]) begin
shalan0d14e6e2020-08-31 16:50:48 +0200178 if (io_ctrl_sel[i]) begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400179 iomem_rdata <= io_ctrl[i];
180 // NOTE: Byte-wide write to io_ctrl is prohibited
shalan0d14e6e2020-08-31 16:50:48 +0200181 if (iomem_wstrb[0])
Tim Edwardsc18c4742020-10-03 11:26:39 -0400182 io_ctrl[i] <= iomem_wdata[IO_CTRL_BITS-1:0];
shalan0d14e6e2020-08-31 16:50:48 +0200183 end
184 end
185 end
186 end
187 end
188 endgenerate
189
190 generate
Tim Edwardsc18c4742020-10-03 11:26:39 -0400191 for (i=0; i<PWR_PADS; i=i+1) begin
shalan0d14e6e2020-08-31 16:50:48 +0200192 always @(posedge clk) begin
193 if (!resetn) begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400194 pwr_ctrl[i] <= 'd0;
shalan0d14e6e2020-08-31 16:50:48 +0200195 end else begin
shalan0d14e6e2020-08-31 16:50:48 +0200196 if (iomem_valid && !iomem_ready && iomem_addr[31:8] == BASE_ADR[31:8]) begin
shalan0d14e6e2020-08-31 16:50:48 +0200197 if (pwr_ctrl_sel[i]) begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400198 iomem_rdata <= pwr_ctrl[i];
shalan0d14e6e2020-08-31 16:50:48 +0200199 if (iomem_wstrb[0])
Tim Edwardsc18c4742020-10-03 11:26:39 -0400200 pwr_ctrl[i] <= iomem_wdata[PWR_CTRL_BITS-1:0];
shalan0d14e6e2020-08-31 16:50:48 +0200201 end
202 end
203 end
204 end
205 end
206 endgenerate
207
Tim Edwards04ba17f2020-10-02 22:27:50 -0400208 reg [3:0] xfer_count;
209 reg [5:0] pad_count;
210 reg [1:0] xfer_state;
211 reg serial_clock;
212 reg serial_resetn;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400213
Tim Edwardsc18c4742020-10-03 11:26:39 -0400214 // NOTE: Ignoring power control bits for now. . . need to revisit.
215 // Depends on how the power pads are arranged among the GPIO, and
216 // whether or not switching will be internal and under the control
217 // of the SoC.
Tim Edwards04ba17f2020-10-02 22:27:50 -0400218
Tim Edwardsc18c4742020-10-03 11:26:39 -0400219 reg [IO_CTRL_BITS-1:0] serial_data_staging;
220
Tim Edwards251e0df2020-10-05 11:02:12 -0400221 wire serial_data_out;
222 wire busy;
223
224 assign serial_data_out = serial_data_staging[IO_CTRL_BITS-1];
225 assign busy = (xfer_state != `IDLE);
226
Tim Edwardsc18c4742020-10-03 11:26:39 -0400227 always @(posedge clk or negedge resetn) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400228 if (resetn == 1'b0) begin
229
Tim Edwards44bab472020-10-04 22:09:54 -0400230 xfer_state <= `IDLE;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400231 xfer_count <= 4'd0;
Tim Edwards251e0df2020-10-05 11:02:12 -0400232 pad_count <= IO_PADS;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400233 serial_resetn <= 1'b0;
234 serial_clock <= 1'b0;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400235
236 end else begin
237
Tim Edwards44bab472020-10-04 22:09:54 -0400238 if (xfer_state == `IDLE) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400239 pad_count <= IO_PADS;
240 serial_resetn <= 1'b1;
Tim Edwards44bab472020-10-04 22:09:54 -0400241 serial_clock <= 1'b0;
242 if (xfer_ctrl == 1'b1) begin
243 xfer_state <= `START;
244 end
245 end else if (xfer_state == `START) begin
Tim Edwards04ba17f2020-10-02 22:27:50 -0400246 serial_resetn <= 1'b1;
247 serial_clock <= 1'b0;
248 xfer_count <= 6'd0;
Tim Edwards251e0df2020-10-05 11:02:12 -0400249 pad_count <= pad_count - 1;
250 xfer_state <= `XBYTE;
251 serial_data_staging <= io_ctrl[pad_count - 1];
Tim Edwards04ba17f2020-10-02 22:27:50 -0400252 end else if (xfer_state == `XBYTE) begin
253 serial_resetn <= 1'b1;
254 serial_clock <= ~serial_clock;
255 if (serial_clock == 1'b0) begin
Tim Edwards251e0df2020-10-05 11:02:12 -0400256 if (xfer_count == IO_CTRL_BITS - 1) begin
257 if (pad_count == 0) begin
258 xfer_state <= `LOAD;
259 end else begin
260 xfer_state <= `START;
261 end
Tim Edwards04ba17f2020-10-02 22:27:50 -0400262 end else begin
263 xfer_count <= xfer_count + 1;
264 end
265 end else begin
Tim Edwardsc18c4742020-10-03 11:26:39 -0400266 serial_data_staging <= {serial_data_staging[IO_CTRL_BITS-2:0], 1'b0};
Tim Edwards04ba17f2020-10-02 22:27:50 -0400267 end
268 end else if (xfer_state == `LOAD) begin
269 xfer_count <= xfer_count + 1;
270
271 /* Load sequence: Raise clock for final data shift in;
272 * Pulse reset low while clock is high
273 * Set clock back to zero.
274 * Return to idle mode.
275 */
276 if (xfer_count == 4'd0) begin
277 serial_clock <= 1'b1;
278 serial_resetn <= 1'b1;
279 end else if (xfer_count == 4'd1) begin
280 serial_clock <= 1'b1;
281 serial_resetn <= 1'b0;
282 end else if (xfer_count == 4'd2) begin
283 serial_clock <= 1'b1;
284 serial_resetn <= 1'b1;
285 end else if (xfer_count == 4'd3) begin
286 serial_resetn <= 1'b1;
287 serial_clock <= 1'b0;
Tim Edwards44bab472020-10-04 22:09:54 -0400288 xfer_state <= `IDLE;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400289 end
290 end
291 end
292 end
293
294endmodule