A generic 8-bit General Purpose I/O (GPIO) Peripheral with the following features
APB and AHBL wrappers, generated by the IP_Utilities amba_wrap.py
utility, is provided. WB wrapper will be provided soon. All wrappers provide the same programmer's interface as outlined in the following sections.
Based on your use case, use one of the provided wrappers or create a wrapper for your system bus type. For an example of how to integrate the APB wrapper:
EF_GPIO8_APB INST (
`TB_APB_SLAVE_CONN,
.io_in(io_in)
.io_out(io_out)
.io_oe(io_oe)
);
NOTE: `TB_APB_SLAVE_CONN is a convenient macro provided by IP_Utilities.
The following table is the result for implmenting the EF_GPIO8 IP with different wrappers using Sky130 PDK and yosys.
Module | Number of cells | Max. freq |
---|---|---|
EF_GPIO8 | 56 | |
EF_GPIO8_APB | 512 | |
EF_GPIO8_AHBL | 547 | |
EF_GPIO8_WB |
Name | Offset | Reset Value | Access Mode | Description |
---|---|---|---|---|
DATAI | 0000 | 0x00000000 | r | Data In Register; Reading from this register returns the pins status (8 pins); one bit per pin. |
DATAO | 0004 | 0x00000000 | w | Data Out Register; Writing to this register change the status of the port pins (8 pins); one bit per pin. |
DIR | 0008 | 0x00000000 | w | Direction Register; One bit per pin 1: output, 0: input. |
IM | 0f00 | 0x00000000 | w | Interrupt Mask Register; write 1/0 to enable/disable interrupts; check the interrupt flags table for more details. |
RIS | 0f08 | 0x00000000 | w | Raw Interrupt Status; reflects the current interrupts status;check the interrupt flags table for more details. |
MIS | 0f04 | 0x00000000 | w | Masked Interrupt Status; On a read, this register gives the current masked status value of the corresponding interrupt. A write has no effect; check the interrupt flags table for more details. |
IC | 0f0c | 0x00000000 | w | Interrupt Clear Register; On a write of 1, the corresponding interrupt (both raw interrupt and masked interrupt, if enabled) is cleared; check the interrupt flags table for more details. |
Data In Register; Reading from this register returns the pins status (8 pins); one bit per pin.
Data Out Register; Writing to this register change the status of the port pins (8 pins); one bit per pin.
Direction Register; One bit per pin 1: output, 0: input.
The wrapped IP provides four registers to deal with interrupts: IM, RIS, MIS and IC. These registers exist for all wrapper types generated by the IP_Utilities amba_wrap.py
utility.
Each register has a group of bits for the interrupt sources/flags.
IM
: is used to enable/disable inetrrupt sources.RIS
: has the current interrupt status (interruot flags) whether they are enabled or diabled.MIS
: is the result of masking (ANDing) RIS by IM.IC
: is used to clear an inetrrupt flag.The following are the bit definitions for the interrupt registers:
Bit | Flag | Width | Description |
---|---|---|---|
0 | P0HI | 1 | Pin 0 is high |
1 | P1HI | 1 | Pin 1 is high |
2 | P2HI | 1 | Pin 2 is high |
3 | P3HI | 1 | Pin 3 is high |
4 | P4HI | 1 | Pin 4 is high |
5 | P5HI | 1 | Pin 5 is high |
6 | P6HI | 1 | Pin 6 is high |
7 | P7HI | 1 | Pin 7 is high |
8 | P0LO | 1 | Pin 0 is low |
9 | P1LO | 1 | Pin 1 is low |
10 | P2LO | 1 | Pin 2 is low |
11 | P3LO | 1 | Pin 3 is low |
12 | P4LO | 1 | Pin 4 is low |
13 | P5LO | 1 | Pin 5 is low |
14 | P6LO | 1 | Pin 6 is low |
15 | P7LO | 1 | Pin 7 is low |
16 | P0PE | 1 | Pin 0 has observed a rising edge |
17 | P1PE | 1 | Pin 1 has observed a rising edge |
18 | P2PE | 1 | Pin 2 has observed a rising edge |
19 | P3PE | 1 | Pin 3 has observed a rising edge |
20 | P4PE | 1 | Pin 4 has observed a rising edge |
21 | P5PE | 1 | Pin 5 has observed a rising edge |
22 | P6PE | 1 | Pin 6 has observed a rising edge |
23 | P7PE | 1 | Pin 7 has observed a rising edge |
24 | P0NE | 1 | Pin 0 has observed a falling edge |
25 | P1NE | 1 | Pin 1 has observed a falling edge |
26 | P2NE | 1 | Pin 2 has observed a falling edge |
27 | P3NE | 1 | Pin 3 has observed a falling edge |
28 | P4NE | 1 | Pin 4 has observed a falling edge |
29 | P5NE | 1 | Pin 5 has observed a falling edge |
30 | P6NE | 1 | Pin 6 has observed a falling edge |
31 | P7NE | 1 | Pin 7 has observed a falling edge |
Port | Direction | Width | Description |
---|---|---|---|
io_in | input | 8 | GPIOs input (external interface) |
io_out | output | 8 | GPIOs output (external interface) |
io_oe | output | 8 | GPIOs output enable (external interface) |
bus_in | output | 8 | Synchronized GPIOs input connected to the bus (it drives the DATAI register) |
bus_out | input | 8 | GPIOs output connected to the bus (it's driven by wriring to DATAO register) |
bus_oe | input | 8 | GPIOs output enable connected to the bus (it's driven by wriring to DIR register) |
pin0_hi | output | 1 | Pin 0 high flag |
pin1_hi | output | 1 | Pin 1 high flag |
pin2_hi | output | 1 | Pin 2 high flag |
pin3_hi | output | 1 | Pin 3 high flag |
pin4_hi | output | 1 | Pin 4 high flag |
pin5_hi | output | 1 | Pin 5 high flag |
pin6_hi | output | 1 | Pin 6 high flag |
pin7_hi | output | 1 | Pin 7 high flag |
pin0_lo | output | 1 | Pin 0 low flag |
pin1_lo | output | 1 | Pin 1 low flag |
pin2_lo | output | 1 | Pin 2 low flag |
pin3_lo | output | 1 | Pin 3 low flag |
pin4_lo | output | 1 | Pin 4 low flag |
pin5_lo | output | 1 | Pin 5 low flag |
pin6_lo | output | 1 | Pin 6 low flag |
pin7_lo | output | 1 | Pin 7 low flag |
pin0_pe | output | 1 | Pin 0 positive edge flag |
pin1_pe | output | 1 | Pin 1 positive edge flag |
pin2_pe | output | 1 | Pin 2 positive edge flag |
pin3_pe | output | 1 | Pin 3 positive edge flag |
pin4_pe | output | 1 | Pin 4 positive edge flag |
pin5_pe | output | 1 | Pin 5 positive edge flag |
pin6_pe | output | 1 | Pin 6 positive edge flag |
pin7_pe | output | 1 | Pin 7 positive edge flag |
pin0_ne | output | 1 | Pin 0 negative edge flag |
pin1_ne | output | 1 | Pin 1 negative edge flag |
pin2_ne | output | 1 | Pin 2 negative edge flag |
pin3_ne | output | 1 | Pin 3 negative edge flag |
pin4_ne | output | 1 | Pin 4 negative edge flag |
pin5_ne | output | 1 | Pin 5 negative edge flag |
pin6_ne | output | 1 | Pin 6 negative edge flag |
pin7_ne | output | 1 | Pin 7 negative edge flag |
DATAO
registerDATAI
registerYou can either clone repo or use IPM which is an open-source IPs Package Manager
git clone https://github.com/efabless/EF_GPIO8
ipm install EF_GPIO8
EF_GPIO8/verify/utb/
run make APB-RTL
to run testbench for APB or make AHBL-RTL
to run textbench for AHBLTBD
EF_GPIO8
Vendor
Efabless
130nm
Skywater
General Purpose I/O
Free
Open Source
Apache
EF Certified
Integrated