occheung
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

doc: artiq_coreconfig → artiq_coremgmt config. Closes #1111

This commit is contained in:
Sebastien Bourdeauducq 2018-07-20 11:59:07 +08:00
parent cab0ba408d
commit 766d87f626
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/manual/core_device.rst
View File

@ -17,7 +17,7 @@ This storage area is used to store the core device MAC address, IP address and e
The flash storage area is one sector (typically 64 kB) large and is organized as a list of key-value records. The flash storage area is one sector (typically 64 kB) large and is organized as a list of key-value records.
This flash storage space can be accessed by using ``artiq_coreconfig`` (see: :ref:`core-device-configuration-tool`). This flash storage space can be accessed by using ``artiq_coremgmt`` (see: :ref:`core-device-management-tool`).
.. _board-ports: .. _board-ports:

10
doc/manual/installing.rst
View File

@ -182,13 +182,13 @@ To flash the idle kernel:
* Write it into the core device configuration flash storage: :: * Write it into the core device configuration flash storage: ::
$ artiq_coreconfig write -f idle_kernel idle.elf $ artiq_coremgmt config -f idle_kernel idle.elf
.. note:: You can find more information about how to use the ``artiq_coreconfig`` utility on the :ref:`Utilities <core-device-configuration-tool>` page. .. note:: You can find more information about how to use the ``artiq_coremgmt`` utility on the :ref:`Utilities <core-device-management-tool>` page.
* (optional) Flash the startup kernel * (optional) Flash the startup kernel
The startup kernel is executed once when the core device powers up. It should initialize DDSes, set up TTL directions, etc. Proceed as with the idle kernel, but using the ``startup_kernel`` key in ``artiq_coreconfig``. The startup kernel is executed once when the core device powers up. It should initialize DDSes, set up TTL directions, etc. Proceed as with the idle kernel, but using the ``startup_kernel`` key in the ``artiq_coremgmt`` command.
For DRTIO systems, the startup kernel should wait until the desired links are up, using :meth:`artiq.coredevice.Core.get_drtio_link_status`. For DRTIO systems, the startup kernel should wait until the desired links are up, using :meth:`artiq.coredevice.Core.get_drtio_link_status`.
@ -196,8 +196,8 @@ For DRTIO systems, the startup kernel should wait until the desired links are up
Some core devices may use either an external clock signal or their internal clock. The clock is selected at power-up. Use one of these commands: :: Some core devices may use either an external clock signal or their internal clock. The clock is selected at power-up. Use one of these commands: ::
$ artiq_coreconfig write -s rtio_clock i # internal clock (default) $ artiq_coremgmt config write -s rtio_clock i # internal clock (default)
$ artiq_coreconfig write -s rtio_clock e # external clock $ artiq_coremgmt config write -s rtio_clock e # external clock
.. rubric:: Footnotes .. rubric:: Footnotes

2
doc/manual/utilities.rst
View File

@ -104,7 +104,7 @@ Flashing/Loading tool
:ref: artiq.frontend.artiq_flash.get_argparser :ref: artiq.frontend.artiq_flash.get_argparser
:prog: artiq_flash :prog: artiq_flash
.. _core-device-configuration-tool: .. _core-device-management-tool:
Core device management tool Core device management tool
--------------------------- ---------------------------