Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
reference:programmable-logic:eclypse-z7:zmodlibuserguide [2019/12/03 14:11]
Cristian Fatu
reference:programmable-logic:eclypse-z7:zmodlibuserguide [2020/01/09 18:43] (current)
Arthur Brown
Line 1: Line 1:
-====== ZmodLib library user guide ====== +renamed / moved to [[https://​reference.digilentinc.com/​reference/​zmod/​zmodbaselibraryuserguide|New location]]
- +
-Digilent provides the ZmodLib library ​to handle the Zmod modules functionality. It covers both linux and baremetal (standalone) platforms. +
-The current demos are provided for the usage of Zmods attached to Eclipse board, still Zmods can be attached to any board providing the SZG connector.\\  +
-The library is interfacing with [[https://​reference.digilentinc.com/​reference/​zmod/​zmodadc/​zmod_adc_ip_highlevel_user_guide|Zmod ADC 1410 High Level Controller IP Core]] and [[https://​reference.digilentinc.com/​reference/​zmod/​zmoddac/​zmod_dac_ip_highlevel_user_guide|Zmod DAC 1411 High Level Controller IP Core]]. +
- +
- +
- +
-====== Library structure ====== +
-===== ZMOD base class ===== +
-This class is implemented as a base class of the classes corresponding to the individual Zmods ([[#​zmodadc1410_class|ZMODADC1410 class]], [[#​zmoddac1411_class|ZMODDAC1411 class]]). It implements the functionality common to all Pmods. +
-It uses register definitions detailed in [[#​register_definitions|Register Definitions]] chapter. +
-===== ZMODADC1410 class ===== +
-===== ZmodDAC1411 class ===== +
-====== Register definitions ====== +
-^ Address ​                     ^ Register ​                                                  ^ Field                                                                                                                                                                             ​|||| +
-| :::                          | :::                                                        ^ Field name                                                   ^ Start bit                  ^ Length ​                    ^ Description ​                                                ^ +
-| 0x00                         | ZMOD_REG_ADDR_CR ​                                          | ZMOD_REGFLD_CR_CMD_RUNSTP ​                                   | 1                          | 1                          | CMD_RUNSTP field of CR register ​                            | +
-| :::                          | :::                                                        | ZMOD_REGFLD_CR_CMD_READ_EN ​                                  | 2                          | 1                          | CMD_READ_EN field of CR register ​                           | +
-| :::                          | :::                                                        | ZMOD_REGFLD_CR_INTR_EN ​                                      | 3                          | 1                          | INTR_EN field of CR register ​                               | +
-| :::                          | :::                                                        | ZMOD_REGFLD_CR_RUNSTOP ​                                      | 4                          | 1                          | RUNSTOP field of CR register ​                               | +
-| :::                          | :::                                                        | ZMOD_REGFLD_CR_RST ​                                          | 31                         | 1                          | RST field of CR register ​                                   | +
-| 0x04                         | ZMOD_REG_ADDR_SR ​                                          | ZMOD_REGFLD_SR_TX_DONE ​                                      | 0                          | 1                          | TX_DONE field of SR register ​                               | +
-| :::                          | :::                                                        | ZMOD_REGFLD_SR_CMD_RUNNING ​                                  | 2                          | 1                          | CMD_RUNNING field of SR register ​                           | +
-| :::                          | :::                                                        | ZMOD_REGFLD_SR_CMD_TX_COUNT ​                                 | 3                          | 7                          | CMD_TX_COUNT field of SR register ​                          | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_SR_BIT_BUF_FULL</​color> ​          | <color #​22b14c>​21</​color> ​ | <color #​22b14c>​1</​color> ​  | <color #​22b14c>​BUF_FULL field of SR register</​color> ​       | +
-| 0x08                         | ZMOD_REG_ADDR_IER ​                                         | ZMOD_REGFLD_IER_CMD_TX_DONE ​                                 | 0                          | 1                          | CMD_TX_DONE field of IER register ​                          | +
-| :::                          | :::                                                        | ZMOD_REGFLD_IER_CMD_RX_DONE ​                                 | 1                          | 1                          | CMD_RX_DONE field of IER register ​                          | +
-| :::                          | :::                                                        | ZMOD_REGFLD_IER_CMD_TX_RX_ERROR ​                             | 2                          | 4                          | CMD_TX_RX_ERROR field of IER register ​                      | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_IER_BUF_FULL</​color> ​      | <color #​22b14c>​21</​color> ​ | <color #​22b14c>​1</​color> ​  | <color #​22b14c>​BUF_FULL field of IER register</​color> ​      | +
-| 0x14                         | ZMOD_REG_ADDR_AXIS_S2MM_LENGTH ​                            | ZMOD_REGFLD_AXIS_S2MM_LENGTH_LENGTH ​                         | 0                          | 26                         | LENGTH field of AXIS_S2MM_LENGTH register ​                  | +
-| 0x18                         | ZMOD_REG_ADDR_AXIS_MM2S_LENGTH ​                            | ZMOD_REGFLD_AXIS_MM2S_LENGTH_LENGTH ​                         | 0                          | 26                         | LENGTH field of AXIS_MM2S_LENGTH register ​                  | +
-| <color #​22b14c>​0x1C</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_TRIG</​color> ​          | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_CHANNEL</​color> ​      | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​2</​color> ​  | <color #​22b14c>​CHANNEL field of TRIG register</​color> ​      | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_MODE</​color> ​         | <color #​22b14c>​2</​color> ​  | <color #​22b14c>​2</​color> ​  | <color #​22b14c>​MODE field of TRIG register</​color> ​         | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_EDGE</​color> ​         | <color #​22b14c>​4</​color> ​  | <color #​22b14c>​1</​color> ​  | <color #​22b14c>​EDGE field of TRIG register</​color> ​         | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_LEVEL</​color> ​        | <color #​22b14c>​5</​color> ​  | <color #​22b14c>​14</​color> ​ | <color #​22b14c>​LEVEL field of TRIG register</​color> ​        | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_SC1_AC_DC</​color> ​    | <color #​22b14c>​19</​color> ​ | <color #​22b14c>​1</​color> ​  | <color #​22b14c>​SC1_AC_DC field of TRIG register</​color> ​    | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_SC2_AC_DC</​color> ​    | <color #​22b14c>​20</​color> ​ | <color #​22b14c>​1</​color> ​  | <color #​22b14c>​SC2_AC_DC field of TRIG register</​color> ​    | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_SC1_HG_LG</​color> ​    | <color #​22b14c>​21</​color> ​ | <color #​22b14c>​1</​color> ​  | <color #​22b14c>​SC1_HG_LG field of TRIG register</​color> ​    | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_SC2_HG_LG</​color> ​    | <color #​22b14c>​22</​color> ​ | <color #​22b14c>​1</​color> ​  | <color #​22b14c>​SC2_HG_LG field of TRIG register</​color> ​    | +
-| :::                          | :::                                                        | <color #​22b14c>​ZMODADC1410_REGFLD_TRIG_SYNC</​color> ​         | <color #​22b14c>​23</​color> ​ | <color #​22b14c>​4</​color> ​  | <color #​22b14c>​SYNC field of TRIG register</​color> ​         | +
-| <color #​22b14c>​0x20</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_WINDOW</​color> ​        | <color #​22b14c>​ZMODADC1410_REGFLD_WINDOW_WND</​color> ​        | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​24</​color> ​ | <color #​22b14c>​WND field of WINDOW register</​color> ​        | +
-| <color #​22b14c>​0x24</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_SC1LGMULTCOEF</​color> ​ | <color #​22b14c>​ZMODADC1410_REGFLD_SC1LGMULTCOEF_VAL</​color> ​ | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​18</​color> ​ | <color #​22b14c>​VAL field of SC1LGMULTCOEF register</​color> ​ | +
-| <color #​22b14c>​0x28</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_SC1HGMULTCOEF</​color> ​ | <color #​22b14c>​ZMODADC1410_REGFLD_SC1HGMULTCOEF_VAL</​color> ​ | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​18</​color> ​ | <color #​22b14c>​VAL field of SC1HGMULTCOEF register</​color> ​ | +
-| <color #​22b14c>​0x2C</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_SC1LGADDCOEF</​color> ​  | <color #​22b14c>​ZMODADC1410_REGFLD_SC1LGADDCOEF_VAL</​color> ​  | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​18</​color> ​ | <color #​22b14c>​VAL field of SC1LGADDCOEF register</​color> ​  | +
-| <color #​22b14c>​0x30</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_SC1HGADDCOEF</​color> ​  | <color #​22b14c>​ZMODADC1410_REGFLD_SC1HGADDCOEF_VAL</​color> ​  | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​18</​color> ​ | <color #​22b14c>​VAL field of SC1HGADDCOEF register</​color> ​  | +
-| <color #​22b14c>​0x34</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_SC2LGMULTCOEF</​color> ​ | <color #​22b14c>​ZMODADC1410_REGFLD_SC2LGMULTCOEF_VAL</​color> ​ | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​18</​color> ​ | <color #​22b14c>​VAL field of SC2LGMULTCOEF register</​color> ​ | +
-| <color #​22b14c>​0x38</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_SC2HGMULTCOEF</​color> ​ | <color #​22b14c>​ZMODADC1410_REGFLD_SC2HGMULTCOEF_VAL</​color> ​ | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​18</​color> ​ | <color #​22b14c>​VAL field of SC2HGMULTCOEF register</​color> ​ | +
-| <color #​22b14c>​0x3C</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_SC2LGADDCOEF</​color> ​ | <color #​22b14c>​ZMODADC1410_REGFLD_SC2LGADDCOEF_VAL</​color> ​ | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​18</​color> ​ | <color #​22b14c>​VAL field of SC2LGADDCOEF register</​color> ​ | +
-| <color #​22b14c>​0x40</​color> ​ | <color #​22b14c>​ZMODADC1410_REG_ADDR_SC2HGADDCOEFF </​color> ​ | <color #​22b14c>​ZMODADC1410_REGFLD_SC2HGADDCOEF_VAL</​color> ​ | <color #​22b14c>​0</​color> ​  | <color #​22b14c>​18</​color> ​ | <color #​22b14c>​VAL field of SC2HGADDCOEF register</​color> ​ | +
- +