Page History
...
The timing/bsa package and the bsaDriver module are incharge in charge of all acquisition services, namely: Beam Line Data (BLD), Beam Synchronous Acquisition (BSA), Beam Synchronous Acquisition Service (BSAS), and Beam Synchronous Scalar Service (BSSS) for the super conducting superconducting accelerator.
...
timing/bsa package
| Gliffy Diagram | ||||||||
|---|---|---|---|---|---|---|---|---|
|
TBD
Introduction
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.
Package/module file structure
- AcqServiceYaml.cc/hh : Contains the base class for BSSS and BLD acquisition services. This base class established communication with CPSW, and provides API method to the upper layers to control and acquire data from BLD and BSSS streams.
- BldYaml.cc/hh : Implements AcqServiceYaml class with 4 Event definitions
- BsssYaml.cc/hh: Implements AcqServiceYaml class with 9 Event definitions
- AmcCarrier.cc/hh:
- AmcCarrierBase.cc/hh
- AmcCarrierYaml.cc/hh
- bld_control.cc
- bsa_tst.cc
- bsaapp_tst.cc
- BsaDefs.ccc/hh
- BsaField.hh
- BsasYaml.cc/hh
- bsayaml_tst.cc
- cpsw_duo.cc
- cpsw_tst.cc
- CpswTemplate.hh
- cpu_tst.cc
- Processor.cc/hh
- ProcessorT.hh
- RamControl.cc/hh : Defines IRamControl and CRamControlImpl classes. Later on, something called control, waveform1 and waveform2 will be instantiated with IRamControl. Seems like all three have the same memory layout
- socketAPI.cc/hh : Socket class that opens a socket and sends data over multicast
- TPG.cc/hh :
- TPGMini.cc/hh
- tpr_stream.cc
- yaml_tst.cc
YAMLs
The timing/bsa requires paths that will denote the relevant registers/streams/and drams described in the YAML files. The necessary YAML files are as follows
...
| Register Index | YAML File | Stream/Register name | Description |
|---|---|---|---|
| 1 | BldAxiStream.yaml | packetSize | Maximum size of packets in 32b words |
| 2 | enable | service enable | |
| 3 | channelMask | Mask of enabled channels | |
| 4 | currPacketSize | Current size of packet in 32b words | |
| 5 | currPacketState | Current packet fill state. Relevant to the statemachine filling the packet in the firmware and irrelevant to the software engineer | |
| 6 | currPulseIdL | Current packet pulseID lower word | |
| 7 | currTimeStampL | Current packet timestamp lower word | |
| 8 | currDelta | Current compressed timestamp/pulseID | |
| 9 | packetCount | Generated packet count | |
| 10 | paused | Stream paused | |
| 11 | diagnClockRate | Diagnostic bus clock rate | |
| 12 | diagnStrobeRate | Diagnostic bus strobe rate | |
| 13 | eventSel0Rate | Event select0 rate | |
| 14 | EdefEnable[#EDEFS] | Enable a specific event definition | |
| 15 | EdefRateLimit[#EDEFS] | Event definition rate limit | |
| 16 | EdefRateSel[#EDEFS] | Event definition rate select | |
| 17 | EdefDestSel[#EDEFS] | Event definition destination select | |
Class(es)/file(es) descriptions
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.
Exception handling (if applicable)
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.
Extension (if applicable)
Is the package extendable to add a new function or to modify an existing function? If so, it needs to be mentioned here.
Exported IOC shell commands, description and parameters (if applicable)
All EPICS shell commands provided should be described here with their input parameters.
PV name list (if applicable)
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.
bldStream.cpp
Contains functions and structures to read the BLD/BSSS/BSAS stream coming from the firmware and call the registered callback functions with the stream data stored in buffers. It also provides functions to print statistics. This file forms an EPICS driver run at IOC boot automatically without any user setup or configuration.
...
| Gliffy Diagram | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Detailing of the static functions available in the file
| Gliffy Diagram | ||||||
|---|---|---|---|---|---|---|
|
| Gliffy Diagram | ||||||
|---|---|---|---|---|---|---|
|
...
| Gliffy Diagram | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Service Asyn driver (serviceAsynDriver.cpp)
This Asyn driver is used to initialize both BSSS and BLD since they both have identical firmware structures. This file contains some similar structures with bldStream.cpp file. A static pointer is declared globally in the file, and used to store different service drivers in a linked list.
...
The reported number channel data in the packet is variable and not necessarily all of the channels will have data. The BSSS callback source code uses the channelMask to identify if the channel data is available or not.
devBsss.c/devBsss.h (BSSS device support)
This device support for BSSS was developed to override the asyn parameters. Apparently the asyn based PVs increase the CPU load significantly. The header file contains functions that will be accessed by external source to update the relevant records. 2 device support records are created
...
BSA asyn driver (bsaAsynDriver.cpp/h)
BSA asyn driver also contains a global static pointer that points to a linkedList of all drivers instantiated, and contains the same set of linkedList functions that were described above. The node structure is as follows
...
Overview
Content Tools