Skip to content

Commit 46b5716

Browse files
committed
[docs] minor edits
1 parent 13624f5 commit 46b5716

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ allows booting application code via UART, TWI or SPI flash or from an SD card
153153

154154
* 32-bit external bus interface - Wishbone-compatible
155155
([XBUS](https://stnolting.github.io/neorv32/#_processor_external_bus_interface_xbus));
156-
[wrapper](https://github.com/stnolting/neorv32/blob/main/rtl/system_integration) for AXI4 interfaces
157-
* stream link interface with independent RX and TX channels - AXI4-Stream compatible
156+
[wrapper](https://github.com/stnolting/neorv32/blob/main/rtl/system_integration) for AXI4-compatible interfaces
157+
* stream link interface with independent RX and TX channels - AXI4-Stream-compatible
158158
([SLINK](https://stnolting.github.io/neorv32/#_stream_link_interface_slink))
159159

160160
**Advanced**

docs/datasheet/soc.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ image::neorv32_processor.png[align=center]
3030
* _optional_ two-wire serial interface controller (<<_two_wire_serial_interface_controller_twi,**TWI**>>), compatible to the I²C standard
3131
* _optional_ two-wire serial device controller (<<_two_wire_serial_device_controller_twd,**TWD**>>), compatible to the I²C standard
3232
* _optional_ general purpose parallel IO port (<<_general_purpose_input_and_output_port_gpio,**GPIO**>>), 32 inputs (interrupt capable), 32 outputs
33-
* _optional_ 32-bit external bus interface, Wishbone-compatible (<<_processor_external_bus_interface_xbus,**XBUS**>>), AXI4-bridge available
33+
* _optional_ 32-bit external bus interface, Wishbone-compatible (<<_processor_external_bus_interface_xbus,**XBUS**>>), AXI4-compatible bridge available
3434
* _optional_ watchdog timer (<<_watchdog_timer_wdt,**WDT**>>)
3535
* _optional_ PWM controller with up to 16 individual channels (<<_pulse_width_modulation_controller_pwm,**PWM**>>)
3636
* _optional_ ring-oscillator-based true random number generator (<<_true_random_number_generator_trng,**TRNG**>>)
@@ -39,7 +39,7 @@ image::neorv32_processor.png[align=center]
3939
* _optional_ general purpose 32-bit timer (<<_general_purpose_timer_gptmr,**GPTMR**>>)
4040
* _optional_ 1-wire serial interface controller (<<_one_wire_serial_interface_controller_onewire,**ONEWIRE**>>), compatible to the 1-wire standard
4141
* _optional_ autonomous direct memory access controller (<<_direct_memory_access_controller_dma,**DMA**>>)
42-
* _optional_ stream link interface (<<_stream_link_interface_slink,**SLINK**>>), AXI4-Stream compatible
42+
* _optional_ stream link interface (<<_stream_link_interface_slink,**SLINK**>>), AXI4-Stream-compatible
4343
* _optional_ on-chip debugger with JTAG TAP (<<_on_chip_debugger_ocd,**OCD**>>), optional authentication and hardware breakpoint
4444
* _optional_ execution trace buffer to debug program flow (<<_execution_trace_buffer_tracer,**TRACER**>>) via branch tracing
4545
* _optional_ RVFI-compatible <<_execution_trace_port>> for advanced debugging, profiling and verification
@@ -270,7 +270,7 @@ The generic type "`suv(x:y)`" is an abbreviation for "`std_ulogic_vector(x downt
270270
| `DCACHE_NUM_BLOCKS` | natural | 4 | Number of blocks ("lines"). Has to be a power of two.
271271
| `CACHE_BLOCK_SIZE` | natural | 64 | Size in bytes of each block (I$ and D$). Has to be a power of two, min 8.
272272
| `CACHE_BURSTS_EN` | boolean | true | Enable burst transfers for cache updates.
273-
4+^| **<<_processor_external_bus_interface_xbus>> (Wishbone / AXI4)**
273+
4+^| **<<_processor_external_bus_interface_xbus>> (Wishbone / AXI4-Compatible Bridging)**
274274
| `XBUS_EN` | boolean | false | Implement the external bus interface.
275275
| `XBUS_TIMEOUT` | natural | 2048 | Number of clock cycles after which an unacknowledged external bus access will auto-terminate (0 = disabled).
276276
| `XBUS_REGSTAGE_EN` | boolean | false | Implement XBUS register stages to ease timing closure.
@@ -305,7 +305,7 @@ The generic type "`suv(x:y)`" is an abbreviation for "`std_ulogic_vector(x downt
305305
| `IO_ONEWIRE_FIFO` | natural | 1 | Depth of the <<_one_wire_serial_interface_controller_onewire>> FIFO. Has to be a power of two, min 1, max 32768.
306306
| `IO_DMA_EN` | boolean | false | Implement the <<_direct_memory_access_controller_dma>>.
307307
| `IO_DMA_DSC_FIFO` | natural | 4 | Depth of the DMA transfer descriptor FIFO. Has to be a power of two, min 4, max 512.
308-
| `IO_SLINK_EN` | boolean | false | Implement the <<_stream_link_interface_slink>> (AXI4-Stream).
308+
| `IO_SLINK_EN` | boolean | false | Implement the <<_stream_link_interface_slink>> (AXI4-Stream-Compatible).
309309
| `IO_SLINK_RX_FIFO` | natural | 1 | SLINK RX FIFO depth, has to be a power of two, minimum value is 1, max 32768.
310310
| `IO_SLINK_TX_FIFO` | natural | 1 | SLINK TX FIFO depth, has to be a power of two, minimum value is 1, max 32768.
311311
| `IO_TRACER_EN` | boolean | false | Implement the <<_execution_trace_buffer_tracer>>.

docs/datasheet/soc_xbus.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* Gateway for processor-external modules
3232
* Wishbone-compatible bus protocol
3333
* Optional burst support
34-
* Optional AXI4 bridging
34+
* Optional AXI4-compatible bridging
3535
3636
3737
**Overview**
@@ -60,7 +60,7 @@ see section <<_address_space>>) are **redirected** to the external bus interface
6060
The official Wishbone specification scan be found online:
6161
https://wishbone-interconnect.readthedocs.io/en/latest/index.html
6262

63-
.AXI4 Interface Bridge
63+
.AXI4-Compatible Interface Bridge
6464
[TIP]
6565
A bridge that converts the processor's XBUS interface into an AXI4-compatible host interface is available
6666
in `rtl/system_integration/xbus2axi4_bridge.vhd`. This bridge is also used for the ENORV32 Vivado IP block:

docs/userguide/packaging_vivado.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Packaging the entire processor as IP module allows easy integration of the core
66
into a block-design-based Vivado project. The NEORV32 repository provides a full-scale TCL script that
77
automatically packages the processor as Vivado IP block including an interactive configuration GUI.
88
For this, a specialized wrapper for the processor's top entity is provided
9-
(`rtl/system_integration/neorv32_vivado_ip.vhd`) that features AXI4 (via XBUS)
10-
and AXI4-Stream (via SLINK) compatible interfaces.
9+
(`rtl/system_integration/neorv32_vivado_ip.vhd`) that features AXI4-compatible (via XBUS)
10+
and AXI4-Stream-compatible (via SLINK) interfaces.
1111

1212
.General AXI Wrapper
1313
[NOTE]

rtl/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ These templates can be instantiated directly within a FPGA-specific board wrappe
2222
NEORV32 Processor wrappers dedicated for complex system integration:
2323

2424
* LiteX SoC builder
25-
* Vivado IP integrator providing AXI4-lite and AXI4-stream interfaces
25+
* Vivado IP integrator providing AXI4-compatible and AXI4-stream-compatible interfaces
2626

2727
> [!NOTE]
2828
> These pre-defined top entity wrappers can also be used for custom setups outside of LiteX and Vivado IP designs.

0 commit comments

Comments
 (0)