Skip to content

Commit

Permalink
Update doc & examples
Browse files Browse the repository at this point in the history
  • Loading branch information
patrislav1 committed Sep 26, 2022
1 parent 1da7698 commit 65f2d85
Show file tree
Hide file tree
Showing 25 changed files with 97 additions and 22 deletions.
32 changes: 32 additions & 0 deletions docs/picmg.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,16 @@ PICMG AMC.0 Specification R2.0, Table 3-29
<br>


## CarrierBusedConnectivity
PICMG MicroTCA.4 Enhancements for Rear I/O and Timing R1.0, Table 3-12

|Name |Type |Opt
|----------------------------------------|--------------------|------------------------------|
|`bused_connection_descriptors` |array (BusedConnectionDescriptor)| |

<br>


## Zone3InterfaceDocumentation
PICMG MicroTCA.4 Enhancements for Rear I/O and Timing R1.0, Table 3-15

Expand Down Expand Up @@ -307,3 +317,25 @@ PICMG AMC.0 Specification R2.0, Table 3-30

<br>


## BusedDeviceDescriptor
PICMG MicroTCA.4 Enhancements for Rear I/O and Timing R1.0, Table 3-14

|Name |Type |Opt
|----------------------------------------|--------------------|------------------------------|
|`resource_id` |int (u1) |`on_carrier`, `AMC` |
|`amc_site` |int (u4) | |
|`port` |int (u8) | |

<br>


## BusedConnectionDescriptor
PICMG MicroTCA.4 Enhancements for Rear I/O and Timing R1.0, Table 3-13

|Name |Type |Opt
|----------------------------------------|--------------------|------------------------------|
|`bused_device_descriptor` |array (BusedDeviceDescriptor)| |

<br>

3 changes: 3 additions & 0 deletions docs/records.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
|MtcaCarrierActivationPm |PICMG Specification MTCA.0 R1.0, Table 3-25 |
|CarrierP2pConnectivity |PICMG AMC.0 Specification R2.0, Table 3-13 |
|CarrierClkP2pConnectivity |PICMG AMC.0 Specification R2.0, Table 3-29 |
|CarrierBusedConnectivity |PICMG MicroTCA.4 Enhancements for Rear I/O and Timing R1.0, Table 3-12 |
|Zone3InterfaceDocumentation |PICMG MicroTCA.4 Enhancements for Rear I/O and Timing R1.0, Table 3-15 |

<br>
Expand All @@ -63,6 +64,8 @@
|P2pAmcResourceDescriptor |PICMG AMC.0 Specification R2.0, Table 3-14 |
|P2pClockConnectionDescriptor |PICMG AMC.0 Specification R2.0, Table 3-32 |
|ClockP2pResourceDescriptor |PICMG AMC.0 Specification R2.0, Table 3-30 |
|BusedDeviceDescriptor |PICMG MicroTCA.4 Enhancements for Rear I/O and Timing R1.0, Table 3-14 |
|BusedConnectionDescriptor |PICMG MicroTCA.4 Enhancements for Rear I/O and Timing R1.0, Table 3-13 |

<br>

Expand Down
2 changes: 1 addition & 1 deletion examples/ADRV9375-N.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "ADRV9375-N.bin"
# created with frugy 0.4.0 from "ADRV9375-N.bin"

BoardInfo:
language_code: 25
Expand Down
2 changes: 1 addition & 1 deletion examples/DWC8VM1.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "DWC8VM1.bin"
# created with frugy 0.4.0 from "DWC8VM1.bin"

BoardInfo:
mfg_date_time: 2014-06-09 14:51:00
Expand Down
2 changes: 1 addition & 1 deletion examples/DWC8VM1_HF.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "DWC8VM1_HF.bin"
# created with frugy 0.4.0 from "DWC8VM1_HF.bin"

BoardInfo:
mfg_date_time: 2016-06-03 10:00:00
Expand Down
2 changes: 1 addition & 1 deletion examples/caen-fmc-pico-1m4.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "caen-fmc-pico-1m4.bin"
# created with frugy 0.4.0 from "caen-fmc-pico-1m4.bin"

BoardInfo:
mfg_date_time: 2015-06-10 00:00:00
Expand Down
2 changes: 1 addition & 1 deletion examples/damc-fmc1z7io.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "damc-fmc1z7io.bin"
# created with frugy 0.4.0 from "damc-fmc1z7io.bin"

BoardInfo:
manufacturer: DESY
Expand Down
2 changes: 1 addition & 1 deletion examples/damc-fmc20.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "damc-fmc20.bin"
# created with frugy 0.4.0 from "damc-fmc20.bin"

BoardInfo:
manufacturer: DESY
Expand Down
2 changes: 1 addition & 1 deletion examples/damc-fmc25.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "damc-fmc25.bin"
# created with frugy 0.4.0 from "damc-fmc25.bin"

BoardInfo:
manufacturer: DESY
Expand Down
2 changes: 1 addition & 1 deletion examples/damc-fmc2zup.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "damc-fmc2zup.bin"
# created with frugy 0.4.0 from "damc-fmc2zup.bin"

BoardInfo:
manufacturer: DESY/CAEN ELS
Expand Down
2 changes: 1 addition & 1 deletion examples/desy-dfmc-ad16.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "desy-dfmc-ad16.bin"
# created with frugy 0.4.0 from "desy-dfmc-ad16.bin"

BoardInfo:
mfg_date_time: 2022-01-25 00:00:00
Expand Down
2 changes: 1 addition & 1 deletion examples/desy-dfmc-uniio.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "desy-dfmc-uniio.bin"
# created with frugy 0.4.0 from "desy-dfmc-uniio.bin"

BoardInfo:
mfg_date_time: 2021-03-18 00:00:00
Expand Down
2 changes: 1 addition & 1 deletion examples/dfmc-md22.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "dfmc-md22.bin"
# created with frugy 0.4.0 from "dfmc-md22.bin"

BoardInfo:
mfg_date_time: 2021-07-26 17:00:00
Expand Down
2 changes: 1 addition & 1 deletion examples/dmmc-stamp.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "dmmc-stamp.bin"
# created with frugy 0.4.0 from "dmmc-stamp.bin"

BoardInfo:
manufacturer: DESY
Expand Down
2 changes: 1 addition & 1 deletion examples/drtm-ad84_revD.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "drtm-ad84_revD.bin"
# created with frugy 0.4.0 from "drtm-ad84_revD.bin"

BoardInfo:
mfg_date_time: 2018-05-24 15:00:00
Expand Down
2 changes: 1 addition & 1 deletion examples/drtm-ad84_revE.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "drtm-ad84_revE.bin"
# created with frugy 0.4.0 from "drtm-ad84_revE.bin"

BoardInfo:
mfg_date_time: 2018-05-24 15:00:00
Expand Down
40 changes: 40 additions & 0 deletions examples/drtm-clkft.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# created with frugy 0.4.0 from "drtm-clkft.bin"

BoardInfo:
language_code: 25
mfg_date_time: 2019-01-29 00:00:00
manufacturer: Deutsches Elektronen-Synchrotron
product_name: DRTM-CLKFT
serial_number: N/A

ProductInfo:
language_code: 25
manufacturer: Deutsches Elektronen-Synchrotron
product_name: DRTM-CLKFT
version: Rev. B1
serial_number: N/A
asset_tag: N/A

MultirecordArea:
- type: ModuleCurrentRequirements
current_draw: 2.0

- type: Zone3InterfaceCompatibility
identifier_type: CLASS_ID
identifier_body:
- D1.0

- type: Zone3InterfaceCompatibility
identifier_type: CLASS_ID
identifier_body:
- D1.1

- type: Zone3InterfaceCompatibility
identifier_type: CLASS_ID
identifier_body:
- D1.2

- type: Zone3InterfaceCompatibility
identifier_type: CLASS_ID
identifier_body:
- D1.3
2 changes: 1 addition & 1 deletion examples/drtm-mxc.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "drtm-mxc.bin"
# created with frugy 0.4.0 from "drtm-mxc.bin"

BoardInfo:
manufacturer: DESY
Expand Down
2 changes: 1 addition & 1 deletion examples/drtm-rtm-evalkit.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "drtm-rtm-evalkit.bin"
# created with frugy 0.4.0 from "drtm-rtm-evalkit.bin"

ProductInfo:
language_code: 25
Expand Down
2 changes: 1 addition & 1 deletion examples/fmc+_loopback.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "fmc+_loopback.bin"
# created with frugy 0.4.0 from "fmc+_loopback.bin"

BoardInfo:
mfg_date_time: 2019-11-07 13:10:00
Expand Down
2 changes: 1 addition & 1 deletion examples/fmc-dac-600m-12b-1ch-dds.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "fmc-dac-600m-12b-1ch-dds.bin"
# created with frugy 0.4.0 from "fmc-dac-600m-12b-1ch-dds.bin"

BoardInfo:
mfg_date_time: 2020-08-27 13:36:00
Expand Down
2 changes: 1 addition & 1 deletion examples/mmc-breakout.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "mmc-breakout.bin"
# created with frugy 0.4.0 from "mmc-breakout.bin"

BoardInfo:
manufacturer: DESY
Expand Down
2 changes: 1 addition & 1 deletion examples/opalkelly_default.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "opalkelly_default.bin"
# created with frugy 0.4.0 from "opalkelly_default.bin"

BoardInfo:
manufacturer: Opal Kelly Incorporated
Expand Down
2 changes: 1 addition & 1 deletion examples/opalkelly_default_2k.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "opalkelly_default_2k.bin"
# created with frugy 0.4.0 from "opalkelly_default_2k.bin"

BoardInfo:
manufacturer: Opal Kelly Incorporated
Expand Down
2 changes: 1 addition & 1 deletion examples/uLOG_FRU.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# created with frugy 0.3.0 from "uLOG_FRU.bin"
# created with frugy 0.4.0 from "uLOG_FRU.bin"

BoardInfo:
language_code: 25
Expand Down

0 comments on commit 65f2d85

Please # to comment.