Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated documentation for adding additional io #218

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated documentation for adding additional io #218

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions docs/reference/block.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ this:
ip:
otherconst:
extension:
extra_interface: fmc_mgt: mgt 4


The ``description`` should be a short (a few words) description that will be
visible as a Block label to users of the `pandablocks_device_` when it runs.
Expand All @@ -82,6 +84,12 @@ configuration.
If the ``extension`` field is present then the ``extensions`` directory in the
module must exist and contain a python server extension file.

If the ``extra_interface`` field is present then this block would enable use of
the specified io. This io would also need to have been identified as a capability
and signified with a '*' in the :ref:`Target ini`. THe build system would then
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THe => The

enable this io as if it were specified in the ``io`` section of the target.ini,
up to the lower numer specified here or in the target.ini.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where the number of instances is determined by the lower of the number specified here or that given in the target.ini file.

[FIELD] sections
~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -284,12 +292,20 @@ The first entry to the ini file defines information for the SFP sites for the
target::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, change 'SFP' to 'IO' in

The [.] section
~~~~~~~~~~~~~~~
The first entry to the ini file defines information for the SFP sites for the


[.]
sfp_sites:
sfp_constraints:

The ``sfp_sites`` type is the number of available SFP sites on the target, and
the ``sfp_sites`` type is the name of the constraints file for each SFP site,
located in the target/const directory.
io: sfp: mgt, 3
fmc: 1
fmc_mgt: mgt, 1*
options: pcap_std_dev, PICXO

The ``io`` type describes the IO that is available on the target. The format is
``io_name: io_type, number``. If ``io_type`` is not specified it is assumed
to be the same as ``io_name``. If there is a '*' in ``number`` the target has the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there is a '*' following number

capability to have this number of sites however they are not natively available.
E.g, they can be added by using a specific mezzanine card.

The ``options`` define various functionality that can be enabled in the firmware
however use significant resources that they are not enabled by default. They can be
added in the app.ini.

[BLOCK] sections
~~~~~~~~~~~~~~~~
Expand Down
Loading