Site Map
|
---|
Do you want to write a document describing the software and your lost? If so, you are in the right place. This is a potential outline of what you may want to include in your document.
Here goes a simple description of of the package/module.
Info | ||
---|---|---|
| ||
The common ATCA driver is an API that intermediates ATCACommon EPICS module and CPSW. It abstracts common ATCA registers and provides get and set functions to control them using CPSW. It also makes transparent all the peculiarities of CPSW. |
This contains a list of the capabilities of the module/package i detail. The reader should be able to understand the basic functionalities of this package/module by reading this text.
Info | ||
---|---|---|
| ||
The common ATCA package is responsible for the following:
|
This section should contain the list of files and a simple description of each
Info | ||
---|---|---|
| ||
The files in the package are as follows
|
How does the package/module do what it does? Are there any YAML files? Are there any registers in the YAML files? Which are these registers and what do they represent?
Info | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
The common ATCA package uses the common platform software package (establishes connections with hardware based on protocols and addresses described in YAML files). The API assumes that the CPSW YAML files were already read and parsed successfully. The API requires a path the denote where all the registers will reside. The YAMLs necessary for the correct operation of the common ATCA API are shown as follows
All the registers and streams that will be accessed are in the previously mentioned paths. A summary of the used registers are as follows:
|
Each file/associated classes will be described here. UML diagrams and text description can be used. A UML cheat sheet can be found here. Instantiation information (if applicable) can be mentioned. Flow diagrams for describing the class operation are also welcome. Everything can be developed in Gliffy.
Info | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
This class is responsible for configuring the timing cross bar. The timing cross bar is nothing more than four multiplexers configuring four outputs. The four outputs and the four inputs are as follows:
The UML diagram is shown as follows.
The functions available are simply to instantiate a crossbar, and to configure and read current configuration |
Here you can mention if the package/module throws any exceptions, and you can also mention how these exceptions should be handled in upper layers.
Info | ||
---|---|---|
| ||
The package does not throw any exceptions. Nonetheless, CPSW throws CPSWError errors and the package propagates these exceptions. In these contexts the package prints to stderr. Upper layers should catch exceptions of type CPSWError. |
Is the package extendable to add a new function or to modify an existing function? If so, it needs to be mentioned here.
Info | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
The functionality of debugStream could be extended to call one's own callback along with the default. The API function provided for registering the callback is in the debugStreamInterface.h header file and is as follows
The callback function parameters have to be as follows
In order to read your own (custom stream), following these instructions
This is a streamPoll method example
|
All EPICS shell commands provided should be described here with their input parameters.
Info | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
The IOC shell commands are as follows
|
The PV list goes here. If any other page described some or all PVs, it can be referenced here. The register index can map the PV to the register described in the YAML section above.
Info | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Waveform engine PVs are shown here. The remaining PVs are summarized as follows
|