Skip to content

Commit

Permalink
pre xpd
Browse files Browse the repository at this point in the history
  • Loading branch information
ed-xmos committed Aug 20, 2013
1 parent 5053a4f commit 95862e8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 13 deletions.
2 changes: 1 addition & 1 deletion app_uart_fast/doc/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Import and Build the Application
++++++++++++++++++++++++++++++++

#. Open xTIMEcomposer and check that it is operating in online mode. Open the edit perspective (Window->Open Perspective->XMOS Edit).
#. Locate the ``'Simple/Fast Uart Loopback Example'`` item in the xSOFTip pane on the bottom left of the window and drag it into the Project Explorer window in the xTIMEcomposer. This will also cause the modules on which this application depends (in this case, module_uart_rx & module_uart_tx) to be imported as well.
#. Locate the ``'Simple/Fast Uart Loopback Example'`` item in the xSOFTip pane on the bottom left of the window and drag it into the Project Explorer window in the xTIMEcomposer. This will also cause the modules on which this application depends (in this case, module_uart_fast_rx & module_uart_fast_tx) to be imported as well.

#. Click on the app_uart_fast item in the Project Explorer pane then click on the build icon (hammer) in xTIMEcomposer. Check the console window to verify that the application has built successfully.

Expand Down
14 changes: 6 additions & 8 deletions module_uart_fast_rx/doc/fast.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
Simple UART
===========

The intention of this module is to implement high speed uart, at the expense of threads and 1-bit ports. Other modules provide lower-speed uarts
that are thread-efficient, or that may use fewer 1-bit ports. This module will support a 10 Mbaud rate with 100 MIPS threads, and correspondingly less
with lower MIPS per thread.
The intention of this module is to implement high speed uart, at the expense of logical cores and 1-bit ports. Other modules provide lower-speed uarts
that are logical core-efficient, or that may use fewer 1-bit ports. This module will support a 10 Mbaud rate with 100 MIPS logical cores, and correspondingly less
with lower MIPS per logical core.

Note: the compiler inserts a spurious ZEXT and SETC in two places which makes 10 Mbit fail with 83 MIPS threads.
TODO - still an issue!?

Hardware Platforms
++++++++++++++++++

This UART is supported by all the hardware platforms from XMOS having suitable IO such as XC-1,XC-1A,XC-2,XK-1,etc and can be run on any XS1-L or XS1-G series devices.
This UART is supported by all the hardware platforms from XMOS having suitable IO such as XC-1,XC-1A,XC-2,XK-1,etc and can be run on any XS1 series devices.

The example is prepared to run on the sliceKIT but can be easily modified for other boards with device using a 500 MHz core clock. When running on boards with devices clocking slower than 500MHz, the baud rate should be reduced until it works, which can be done by altering the last "clocks" argument to the call to uart_tx_fast and uart_rx_fast in app_uart_fast/src/main.xc.

Expand Down Expand Up @@ -40,13 +38,13 @@ A function that produces data (just bytes 0..255 in this example)
:start-after: //:: Producer function
:end-before: //::

A function that consumes data (and in this example throws it away)
A function that consumes data

.. literalinclude:: app_uart_fast/src/main.xc
:start-after: //:: Consumer function
:end-before: //::

And a main par that starts the threads:
And a main par that starts the logical cores:

.. literalinclude:: app_uart_fast/src/main.xc
:start-after: //:: Main program
Expand Down
7 changes: 3 additions & 4 deletions module_uart_fast_tx/doc/fast.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@ The intention of this module is to implement high speed uart, at the expense of
that are thread-efficient, or that may use fewer 1-bit ports. This module will support a 10 Mbaud rate with 100 MIPS threads, and correspondingly less
with lower MIPS per thread.

Note: the compiler inserts a spurious ZEXT and SETC in two places which makes 10 Mbit fail with 83 MIPS threads.

Hardware Platforms
++++++++++++++++++

This UART is supported by all the hardware platforms from XMOS having suitable IO such as XC-1,XC-1A,XC-2,XK-1,etc and can be run on any XS1-L or XS1-G series devices.
This UART is supported by all the hardware platforms from XMOS having suitable IO such as XC-1,XC-1A,XC-2,XK-1,etc and can be run on any XS1 series devices.

The example is prepared to run on teh XK-1 but can be easily modified for other boards. However note that a 500 MHz core clock is expected so when running on G4 devices
The example is prepared to run on the L16 sliceKIT but can be easily modified for other boards. However note that a 500 MHz core clock is expected so when running on G4 devices
the baud rate should be reduced until it works, which can be done by altering the last "clocks" argument to the call to uart_tx_fast and uart_rx_fast in app_uart_fast/src/main.xc.

Programming Guide
Expand All @@ -39,7 +38,7 @@ A function that produces data (just bytes 0..255 in this example)
:start-after: //:: Producer function
:end-before: //::

A function that consumes data (and in this example throws it away)
A function that consumes data

.. literalinclude:: app_uart_fast/src/main.xc
:start-after: //:: Consumer function
Expand Down

0 comments on commit 95862e8

Please sign in to comment.