|
|
# WRPC AUX diags
|
|
|
|
|
|
Auxiliary diagnostics in WRPC provide a mechanism for
|
|
|
application-specific data to be exposed by via SNMP by WRPC.
|
|
|
|
|
|
- The application specific data is provided as an array of 32-bit
|
|
|
std\_logic\_vectors to the Board Support Package (BSP) or directly
|
|
|
to WRPC
|
|
|
- Two types of arrays are defined:
|
|
|
- read-only
|
|
|
- read-write
|
|
|
- ID and Version of the AUX diags needs to be provided
|
|
|
- The application specific data can be read/written via SNMP by
|
|
|
addressing OIDs that are constructed based on
|
|
|
- OID of WRPC
|
|
|
- ID and Version of AUX diags
|
|
|
|
|
|
### How-to for gatware developers of application-specific cores
|
|
|
|
|
|
1\. Set generics in Board Support Package (BSP) or directly to WRPC
|
|
|
`g_diag_id
|
|
|
g_diag_ver
|
|
|
g_diag_ro_size
|
|
|
g_diag_rw_size
|
|
|
`
|
|
|
2\. Populate input/output signal ports in Board Support Package (BSP) or
|
|
|
directly to WRPC (the size corresponding to the generics):
|
|
|
`aux_diag_i : in t_generic_word_array(g_diag_ro_size-1 downto 0) :=
|
|
|
(others => (others => '0'));
|
|
|
aux_diag_o : out t_generic_word_array(g_diag_rw_size-1 downto 0);
|
|
|
`
|
|
|
|
|
|
### How-to for software developers of SNMP diagnostics tools
|
|
|
|
|
|
1\. Define your own MIB file, see *lib* folder in *wrpc-sw* repository
|
|
|
for
|
|
|
|
|
|
- template:
|
|
|
[WR-WRPC-AUX-DIAG-MIB.txt](https://www.ohwr.org/project/wrpc-sw/tree/master/)
|
|
|
- example (ID=1, ver=2, streamers):
|
|
|
[WR-WRPC-AUX-STREAMERS-MIB.txt](https://www.ohwr.org/project/wrpc-sw/tree/master/)
|
|
|
|
|
|
2\. The "WRPC AUX diags" available on a WR node can be read from **will
|
|
|
be available in v4.3 of WRPC** :
|
|
|
| **OID number** | **OID name** | **Value for this auxiliary diagnostic
|
|
|
extension** |
|
|
|
| 1.3.6.1.4.1.96.101.1. **** .1.1 | wrpcAuxDiagId | ID |
|
|
|
| 1.3.6.1.4.1.96.101.1. **** .2.1 | wrpcAuxDiagVer | Ver |
|
|
|
| 1.3.6.1.4.1.96.101.1. **** .3.1 | wrpcAuxDiagName | Name (if known)
|
|
|
|
|
|
|
| 1.3.6.1.4.1.96.101.1. **** .4.1 | wrpcAuxDiagMIB | pointer to your mib
|
|
|
(based on ID and Ver numbers) |
|
|
|
|
|
|
3\. The value of the total number of vectors in the two arrays
|
|
|
(read-only and read-write) will be under OIDs:1.3.6.1.4.1.96.101.2. ****
|
|
|
. **** .1.1.2.2.1
|
|
|
|
|
|
4\. The values exposed by your application will be found under OIDs:
|
|
|
|
|
|
- 1.3.6.1.4.1.96.101.2. **** . **** .1.1.2.3.1
|
|
|
|