update docs and remove fw APIs files

efabless · Jan 21, 2025 · bc654aa · bc654aa
1 parent b8ebd7c
commit bc654aa
Show file tree

Hide file tree

Showing 17 changed files with 134 additions and 119 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ The WDT can be enabled/disabled. When it is disabled the counter is loaded with
 
  APB, AHBL, and Wishbone wrappers are provided. All wrappers provide the same programmer's interface as outlined in the following sections.
 
-#### Wrapped IP System Integration
+### Wrapped IP System Integration
 
 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 wishbone wrapper:
 ```verilog
@@ -31,12 +31,14 @@ EF_WDT32_WB INST (
 	.IRQ(irq),
 );
 ```
-#### Wrappers with DFT support
+### Wrappers with DFT support
 Wrappers in the directory ``/hdl/rtl/bus_wrappers/DFT`` have an extra input port ``sc_testmode`` to disable the clock gate whenever the scan chain testmode is enabled.
+### Interrupt Request Line (irq)
+This IP generates interrupts on specific events, which are described in the [Interrupt Flags](#interrupt-flags) section bellow. The IRQ port should be connected to the system interrupt controller.
 
 ## Implementation example  
 
-The following table is the result for implementing the EF_WDT32 IP with different wrappers using Sky130 PDK and [OpenLane2](https://github.com/efabless/openlane2) flow.
+The following table is the result for implementing the EF_WDT32 IP with different wrappers using Sky130 HD library and [OpenLane2](https://github.com/efabless/openlane2) flow.
 |Module | Number of cells | Max. freq |
 |---|---|---|
 |EF_WDT32|TBD| TBD |
@@ -89,13 +91,13 @@ Writing 0 disables the WDT and writing 1 enables it
 The wrapped IP provides four registers to deal with interrupts: IM, RIS, MIS and IC. These registers exist for all wrapper types.
 
 Each register has a group of bits for the interrupt sources/flags.
-- `IM` [offset: 0xff00]: is used to enable/disable interrupt sources.
+- `IM` [offset: ``0xff00``]: is used to enable/disable interrupt sources.
 
-- `RIS` [offset: 0xff08]: has the current interrupt status (interrupt flags) whether they are enabled or disabled.
+- `RIS` [offset: ``0xff08``]: has the current interrupt status (interrupt flags) whether they are enabled or disabled.
 
-- `MIS` [offset: 0xff04]: is the result of masking (ANDing) RIS by IM.
+- `MIS` [offset: ``0xff04``]: is the result of masking (ANDing) RIS by IM.
 
-- `IC` [offset: 0xff0c]: is used to clear an interrupt flag.
+- `IC` [offset: ``0xff0c``]: is used to clear an interrupt flag.
 
 
 The following are the bit definitions for the interrupt registers:
@@ -111,8 +113,24 @@ The IP includes a clock gating feature that allows selective activation and deac
 VERILOG_DEFINES:
 - CLKG_SKY130_HD
 ```
+## Firmware Drivers:
+Firmware drivers for EF_WDT32 can be found in the [EF_WDT32](https://github.com/efabless/EF_APIs_HUB/tree/main/EF_WDT32) directory in the [EF_APIs_HUB](https://github.com/efabless/EF_APIs_HUB) repo. EF_WDT32 driver documentation  is available [here](https://github.com/efabless/EF_APIs_HUB/tree/main/EF_WDT32/README.md).
+You can also find an example C application using the EF_WDT32 drivers [here](https://github.com/efabless/EF_APIs_HUB/tree/main/EF_WDT32/EF_WDT32_example.c).
+## Installation:
+You can install the IP either by cloning this repository or by using [IPM](https://github.com/efabless/IPM).
+### 1. Using [IPM](https://github.com/efabless/IPM):
+- [Optional] If you do not have IPM installed, follow the installation guide [here](https://github.com/efabless/IPM/blob/main/README.md)
+- After installing IPM, execute the following command ```ipm install EF_WDT32```.
+> **Note:** This method is recommended as it automatically installs [EF_IP_UTIL](https://github.com/efabless/EF_IP_UTIL.git) as a dependency.
+### 2. Cloning this repo: 
+- Clone [EF_IP_UTIL](https://github.com/efabless/EF_IP_UTIL.git) repository, which includes the required modules from the common modules library, [ef_util_lib.v](https://github.com/efabless/EF_IP_UTIL/blob/main/hdl/ef_util_lib.v).
+```git clone https://github.com/efabless/EF_IP_UTIL.git```
+- Clone the IP repository
+```git clone https://github.com/efabless/EF_WDT32```
+
+### The Wrapped IP Interface 
 
-### The Interface 
+>**_NOTE:_** This section is intended for advanced users who wish to gain more information about the interface of the wrapped IP, in case they want to create their own wrappers.
 
 <img src="docs/_static/EF_WDT32.svg" width="600"/>
 
@@ -124,17 +142,3 @@ VERILOG_DEFINES:
 |WDTLOAD|input|32|The value loaded into the timer when it reaches zero|
 |WDTTO|output|1|Time out flag|
 |WDTEN|input|1|watchdog timer enable|
-## Firmware Drivers:
-Firmware drivers for EF_WDT32 can be found in the [fw](https://github.com/efabless/EF_WDT32/tree/main/fw) directory. EF_WDT32 driver documentation  is available [here](https://github.com/efabless/EF_WDT32/blob/main/fw/README.md).
-You can also find an example C application using the EF_WDT32 drivers [here]().
-## Installation:
-You can install the IP either by cloning this repository or by using [IPM](https://github.com/efabless/IPM).
-##### 1. Using [IPM](https://github.com/efabless/IPM):
-- [Optional] If you do not have IPM installed, follow the installation guide [here](https://github.com/efabless/IPM/blob/main/README.md)
-- After installing IPM, execute the following command ```ipm install EF_WDT32```.
-> **Note:** This method is recommended as it automatically installs [EF_IP_UTIL](https://github.com/efabless/EF_IP_UTIL.git) as a dependency.
-##### 2. Cloning this repo: 
-- Clone [EF_IP_UTIL](https://github.com/efabless/EF_IP_UTIL.git) repository, which includes the required modules from the common modules library, [ef_util_lib.v](https://github.com/efabless/EF_IP_UTIL/blob/main/hdl/ef_util_lib.v).
-```git clone https://github.com/efabless/EF_IP_UTIL.git```
-- Clone the IP repository
-```git clone https://github.com/efabless/EF_WDT32```
diff --git a/fw/EF_WDT32.c b/fw/EF_WDT32.c
diff --git a/fw/EF_WDT32.h b/fw/EF_WDT32.h
diff --git a/fw/EF_WDT32_regs.h b/fw/EF_WDT32_regs.h
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,
@@ -20,16 +20,44 @@
 #ifndef EF_WDT32REGS_H
 #define EF_WDT32REGS_H
 
+
+/******************************************************************************
+* Includes
+******************************************************************************/
+#include <stdint.h>
+
+/******************************************************************************
+* Macros and Constants
+******************************************************************************/
+
 #ifndef IO_TYPES
 #define IO_TYPES
-#define   __R     volatile const unsigned int
-#define   __W     volatile       unsigned int
-#define   __RW    volatile       unsigned int
+#define   __R     volatile const uint32_t
+#define   __W     volatile       uint32_t
+#define   __RW    volatile       uint32_t
 #endif
 
+#define EF_WDT32_TIMER_REG_TIMER_BIT	((uint32_t)0)
+#define EF_WDT32_TIMER_REG_TIMER_MASK	((uint32_t)0xffffffff)
+#define EF_WDT32_TIMER_REG_MAX_VALUE	((uint32_t)0xFFFFFFFF)
+
+#define EF_WDT32_LOAD_REG_LOAD_BIT	((uint32_t)0)
+#define EF_WDT32_LOAD_REG_LOAD_MASK	((uint32_t)0xffffffff)
+#define EF_WDT32_LOAD_REG_MAX_VALUE	((uint32_t)0xFFFFFFFF)
+
+#define EF_WDT32_CONTROL_REG_CONTROL_BIT	((uint32_t)0)
+#define EF_WDT32_CONTROL_REG_CONTROL_MASK	((uint32_t)0x1)
+#define EF_WDT32_CONTROL_REG_MAX_VALUE	((uint32_t)0x1)
 
-#define EF_WDT32_WDTTO_FLAG	0x1
 
+#define EF_WDT32_WDTTO_FLAG	((uint32_t)0x1)
+
+
+
+/******************************************************************************
+* Typedefs and Enums
+******************************************************************************/
+
 typedef struct _EF_WDT32_TYPE_ {
 	__R 	timer;
 	__W 	load;
@@ -42,5 +70,26 @@ typedef struct _EF_WDT32_TYPE_ {
 	__W 	GCLK;
 } EF_WDT32_TYPE;
 
+typedef struct _EF_WDT32_TYPE_ *EF_WDT32_TYPE_PTR;     // Pointer to the register structure
+
+
+/******************************************************************************
+* Function Prototypes
+******************************************************************************/
+
+
+
+/******************************************************************************
+* External Variables
+******************************************************************************/
+
+
+
+
 #endif
 
+/******************************************************************************
+* End of File
+******************************************************************************/
+
+
diff --git a/hdl/rtl/bus_wrappers/EF_WDT32_AHBL.dev.v b/hdl/rtl/bus_wrappers/EF_WDT32_AHBL.dev.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/EF_WDT32_AHBL.v b/hdl/rtl/bus_wrappers/EF_WDT32_AHBL.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/EF_WDT32_APB.dev.v b/hdl/rtl/bus_wrappers/EF_WDT32_APB.dev.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/EF_WDT32_APB.v b/hdl/rtl/bus_wrappers/EF_WDT32_APB.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/EF_WDT32_WB.dev.v b/hdl/rtl/bus_wrappers/EF_WDT32_WB.dev.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/EF_WDT32_WB.v b/hdl/rtl/bus_wrappers/EF_WDT32_WB.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/dft/EF_WDT32_AHBL_DFT.dev.v b/hdl/rtl/bus_wrappers/dft/EF_WDT32_AHBL_DFT.dev.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/dft/EF_WDT32_AHBL_DFT.v b/hdl/rtl/bus_wrappers/dft/EF_WDT32_AHBL_DFT.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/dft/EF_WDT32_APB_DFT.dev.v b/hdl/rtl/bus_wrappers/dft/EF_WDT32_APB_DFT.dev.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/dft/EF_WDT32_APB_DFT.v b/hdl/rtl/bus_wrappers/dft/EF_WDT32_APB_DFT.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/dft/EF_WDT32_WB_DFT.dev.v b/hdl/rtl/bus_wrappers/dft/EF_WDT32_WB_DFT.dev.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/hdl/rtl/bus_wrappers/dft/EF_WDT32_WB_DFT.v b/hdl/rtl/bus_wrappers/dft/EF_WDT32_WB_DFT.v
@@ -7,7 +7,7 @@
 	you may not use this file except in compliance with the License.
 	You may obtain a copy of the License at
 
-	    http://www.apache.org/licenses/LICENSE-2.0
+	    www.apache.org/licenses/LICENSE-2.0
 
 	Unless required by applicable law or agreed to in writing, software
 	distributed under the License is distributed on an "AS IS" BASIS,