Commit graph

818 commits

Author SHA1 Message Date
Javier Valenzuela
472eb77038 mpm: x4xx: add multiple latency detect iterations
This implements feedback from Xilinx who recommend several measurements
of the tile latency to get a better worst-case estimate.
2023-05-24 08:07:05 -05:00
Martin Braun
85c741bc71 mpm: x4xx: Separate RFDC clock and tile reset
This adds X4xxRfdcCtrl.reset_tiles(), which resets all enabled tiles and
sets their registers and settings back to initial defaults. The same
functionality was previously implemented in reset_rfdc(), but we want to
be able to reset the RFDC clocks without clearing all registers.

During device initialization, however, we retain this reset of all tiles
by modifying the initialization sequence.
2023-05-24 08:06:12 -05:00
Martin Braun
f3ec9fd368 mpm: x4xx: Add additional args parsing in init()
Before this change, we indiscriminately first set the sync source in
init(), then the master clock rate again (it is already set in
set_sync_source(), albeit to a potentially older value).

This adds checks to the args to see if things have actually changed, and
sets all settings in one go.
2023-05-24 08:06:12 -05:00
Martin Braun
009cb8b4c5 mpm: x4xx: Separate RFDC reset from its configuration 2023-05-24 08:06:12 -05:00
Javier Valenzuela
c1d268917e mpm/fpga: x4xx: Major updates in preparation for future devices
FPGA:
- Split up MB registers that control daughterboard specific settings so
  that daughterboards 0 and 1 could have different setings, in
  preparation for future devices that require different settings.
  This requires a compat number bump to 8.0.
- Add registers for additional RFDC information, including the
  block/tile mapping of the individual channels, and information about
  resampling capabilities
- Identify sections of code that would be specific to X410/ZBX and move
  them to their own headers, so it's trivial to add device-specific
  sections of code instead for other devices in the future.
  - This includes constraints for clocks and I/O pins.
- Remove ability to do timed ctrlport transactions to the MB CPLD, this
  was unused and possibly broken.
- Move daughterboard-specific code into its own code location
  (dboards/zbx)
- Move X410-specific register documentation to its own location
  (doc/X410)
- Refactor Makefiles to split out X410/ZBX specific components and allow
  switching between device types
- Add 512-bit AXI interconnects
- Make number of timekeepers configurable (X410 keeps the single
  timekeeper)

MPM:
- Required compat is bumped to 8.0
- Now supports new registers for detecting DSP capabilities and
  multi-rate settings for the daughterboards
- Adds MMCM controls (currently unused)

Co-authored-by: Wade Fife <wade.fife@ni.com>
Co-authored-by: Ryan Marlow <ryan@lmarlow.com>
Co-authored-by: Martin Braun <martin.braun@ettus.com>
Co-authored-by: Humberto Jimenez <humberto.jimenez@ni.com>
2023-05-23 09:06:17 +02:00
Martin Braun
5d98ef2b62 mpm: x4xx: Enable MMCM configuration based on policy 2023-05-22 18:27:23 -05:00
Martin Braun
f5bf1eec9c mpm: x4xx: Enable MPM sync API for X410
This will dynamically set tile latencies, but in a way that multiple
devices stay synchronized.
2023-05-22 18:27:23 -05:00
Martin Braun
63ba6b1c49 mpm: x4xx: Separate RFDC and MMCM resets
Resetting MMCM and RFDC separately will become a requirement once we
start to also program the MMCM. As of now, it is merely a refactoring,
and we continue to use default MMCM settings.
2023-05-22 18:27:23 -05:00
Martin Braun
8120db602a mpm: x4xx: Shut down tiles on tear_down()
- Adds startup_tiles() and shutdown_tiles()
- The latter is called on tear_down() to be compliant with Xilinx'
  documentation on bitstream reconfiguration
2023-05-22 18:27:23 -05:00
Martin Braun
cdc8158112 mpm: utils: Add LogWrapper
This is a debugging utility for MPM, where gdb-based debugging sometimes
leads to issues with timing. To use it, replace class instantiations
such as:
```python
c = SomeClass(arg1, arg2)
```
with
```python
c = LogWrapper(
    parent_log.getChild("SomeClass"), "info", SomeClass(arg1, arg2))
```

The class can be used as before, but the MPM log will include calls with
arguments, return values, and execution times, like this:

```
[MPM.PeriphManager.rfdcctl] [INFO] set_if(1, 0, True, 1058240000.0)
[MPM.PeriphManager.rfdcctl] [INFO] --> True [Execution time: 0.108 ms]
```
2023-05-22 13:30:35 -05:00
Martin Braun
387c2ab581 mpm: x4xx: rfdc: Pull fabric words value from registers
This replaces a hard-coded table of fabric word values (the number of
SPCs from the gearbox FIFO) with a value read back from the RFDC
registers.
2023-05-22 09:09:32 -05:00
Martin Braun
b586a615b5 mpm: x4xx: Refactor x4xx_rfdc_ctrl
Move the converters into more manageable data structures for easier
future access when we need to do more complex settings with the RFDCs.
2023-05-22 09:09:32 -05:00
Martin Anderseck
628b5744d9 MPM: Disable PRC to DB if not required
This change adds a flag to the clock policy that tells the sample PLL to
enable or disable the PLL ref clock (PRC) that goes to the
daughterboards. While for X410 the PRC is required, future USRPs may not
want the clock signal to propagate to the board.
2023-05-22 08:14:23 -05:00
Martin Braun
b1f2858250 mpm: x4xx: rfdc: Add get_converter_rate() API 2023-05-20 11:12:51 -05:00
Martin Braun
d398a02da7 mpm: x4xx: Prepare clock management for multi-mcr
This by itself does not enable dual-rate (or multi-mcr), but it
refactors the code to enable it in the future. Additional changes may be
required.

X4xxClockMgr is renamed to X4xxClockManager.
2023-05-20 11:12:51 -05:00
Martin Braun
cf1b65143d mpm: x4xx: Let RFDC control use clock policy
Before this change, x4xx_rfdc_ctrl.py had various backdoors to read out
required settings. Now that we have the clock policy object, we can
simply read them out from there.

This obviates some code paths (get_rfdc_resampling_factor(),
get_default_mcr(), set_rfdc_reset_cb()).
2023-05-17 13:16:27 -05:00
Martin Braun
3246aec020 mpm: x4xx: Check for tear_down()'s existence
On tear_down() (this is most commonly seen by users when updating the
FPGA image), we add a check to verify that subcomponents of the X4xx are
actually initialized, to avoid displaying a non-fatal error message that
looks like this:

[ERROR] [MPM.RPCServer] Error in update_component while resetting:
    'NoneType' object has no attribute 'tear_down'

The most common/easy way to trigger this error is by loading MPM with
a bitfile that has an invalid compat number (which would stop MPM from
initializing the RFDC controls) and then running `uhd_image_loader`
(which would force a tear_down()). In that circumstance, MPM would try
to call tear_down() on an uninitialized object.
2023-05-17 13:14:35 -05:00
Martin Braun
040d4bb0df mpm: x4xx: Factor clock control out of X4xxClockManager
This splits up x4xx_clk_mgr.py into PLL controls (which go into
x4xx_clock_ctrl.py) and just clock management (which stays in
x4xx_clk_mgr.py).
2023-05-16 18:18:56 -05:00
Martin Braun
8fdbcac6f0 mpm: x4xx: Trust the clock policy's default MCR
This removes a duplicate get_default_mcr() implementation.
2023-05-16 10:47:11 -05:00
Martin Braun
f22b392a00 mpm: x4xx: Rename 'both' argument to 'all'
All call sites that use 'both' as an argument for channel numbers now
use 'all', in preparation for daughterboards that have more than
2 channels.
2023-05-16 10:47:11 -05:00
Martin Braun
62eb62c781 mpm: rfdc: Remove set_sample_rate() API call
This API call is superseded by configure_pll(), and now we match the
RFDC API more closely.
2023-05-16 09:12:29 -05:00
Martin Braun
0b65839d03 x4xx: Update BIST to match clocking refactoring 2023-05-12 15:43:29 -05:00
Martin Braun
cf04329058 mpm: x4xx: Introduce X4xxClockPolicy
This new class encapsulates all clocking-related infos into a single
file and makes it easier to modify clocking settings.
2023-05-12 15:43:29 -05:00
Martin Braun
ac2799fac6 mpm: Fix ZBX CPLD updater
In 01ccb69, changes to the MB CPLD code were made which caused the
following issue when updating the CPLD:

root@ni-x4xx-xxxxxxx:~# zbx_update_cpld --dboards 0
Traceback (most recent call last):
File "/usr/bin/zbx_update_cpld", line 22, in <module>
from usrp_mpm.periph_manager.x4xx_mb_cpld import MboardCPLD
ImportError: cannot import name 'MboardCPLD' from
'usrp_mpm.periph_manager.x4xx_mb_cpld'
(/usr/lib/python3.7/site-packages/usrp_mpm/periph_manager/x4xx_mb_cpld.py)

This fixes this bug.
2023-05-09 17:20:06 -05:00
Martin Braun
f106875a47 mpm: x4xx: Move enable_iq_swap to x4xx_rfdc_ctrl.py
This fixes two issues:
- RfdcRegsControl.enable_iq_swap() now is consistent with other APIs in
  that it takes a channel number, not a block ID
- X4xxDboardIface.enable_iq_swap() doesn't use a backdoor API call to
  fish the enable_iq_swap() API out of the _rfdc_regs object that it
  doesn't own
2023-05-05 11:43:50 -05:00
Martin Braun
b25ed2b6c6 mpm: x4xx: Extend x4xx_rfdc_regs
- Add stubs for APIs we'll need in the future
- Add hard-coded versions of get_converter_mapping() and get_rfdc_info()
2023-05-05 11:43:50 -05:00
Martin Braun
94be5df1e8 mpm: x4xx: Move all clock control to single class
All code in x4xx.py that is specific to clocking is moved to
x4xx_clk_mgr.py. All ancillary code is adapted to call APIs from the
right places.
2023-05-05 11:43:50 -05:00
Martin Braun
d98e0e4994 mpm: Refactor LMK04832X4xx and LMK03328X4xx
- Add class-level attributes to store constants on the chips
- LMK04832X4xx.config() is changed use a SpllConfig object, which is
  temporarily defined in x4xx_clk_mgr.py before calling config()
2023-04-27 22:38:59 -05:00
Martin Braun
997d788353 mpm: x4xx: Minor preparations to x4xx.py for X440 support 2023-04-27 22:31:08 -05:00
Volkan Öz
e88c8e6d11 mpm: Simplify x4xx_bist nsync_fabric
The PLL itself looks good since
it can lock to the OCXO which provides a clean clock.
The Fabric Clock is very jittery which can lead to false fails.
That is why instead of locking to jittry reference signals we will just use
the internal amplitude monitor which per default is enabled and read back the status bit.

Once a signal has been detected the test will pass.
2023-04-20 23:42:12 -05:00
Lars Amsel
677cc33fc5 MPM: fix get_product_id in x4xx BIST
This fixes the eeprom-id mb call such that it also returns
correct values when a module ID for the device is set.

That fix enables resolving the TODO in the x4xx BIST.
It can now use the default implementation to get the
product ID from EEPROM.
2023-04-06 13:15:00 -05:00
Martin Anderseck
400abc624e cpld: Adapt CPLD updater for future X4x0 dboards
This change updates the call to the MB CPLD CTRL and adds logic to
distinguish between X410 and other USRPs, so that we can only force a
wrong CPLD image on a given device.
2023-04-05 13:02:18 -05:00
Martin Braun
36be4006d9 mpm: lmk04832: Move general APIs to base class
The X4xx-specific child class of LMK04832 had implemented some generic
APIs, which are moved into the parent class.
2023-04-03 22:10:45 -05:00
Martin Braun
f3e0f17647 mpm: dboard_iface: Remove {set/get}_if_freq() APIs
These APIs are not used, and are implemented by accessing private
members of child attributes, which is not a good style. Since they are
not used or needed, they can be removed without substitute.
2023-04-02 22:24:31 -05:00
Martin Braun
b17e907923 mpm: x4xx: Conditionally initialize DB flash
ZBX has a daughterboard flash memory, but other daughterboards for X4xx
do not. We therefore add a flag to class ZBX that declares its usage of
a DB flash memory, and X4xxDboardIface uses that flag to conditionally
initialize the DB flash.
2023-04-02 22:24:31 -05:00
Martin Braun
b16631cf5e mpm: Add dboard_info to db_iface initialization 2023-04-02 22:24:31 -05:00
Martin Braun
e08d827346 mpm: Bump compat number to 5.0
This covers the two recent changes:
- Moving the get-rate API into the daughterboard
- Add the new synchronization procedure
2023-03-24 16:08:30 -07:00
Martin Braun
87423d1d75 lib/mpm: Add MPM synchronization API
This adds a new synchronization step in the MPMD device initialization.

- Add API calls to PeriphManagerBase and rpc.py (synchronize() and
  aggregate_sync_data())
- Add sane default implementations to PeriphManagerBase

Note: This adds new APIs to MPM, but we won't change the compat number
in this commit, since the new API is not yet being used.
2023-03-24 16:08:30 -07:00
Martin Braun
d5505e44a8 mpm: x4xx: Move get_master_clock_rate() to DB-RPC
The X4x0 device is an outlier with respect to all other MPM devices when
it comes to this API. All other MPM-devices define this API on the
daughterboard, not the motherboard.

For all the reasons laid out in dboard_manager/base.py, we move this API
call for X4x0 also into the daughterboard RPC space.

Both get_master_clock_rate() and set_master_clock_rate() are explicitly
declared @no_rpc in MPM.

This is an API breakage in the UHD/MPM communication API.
2023-03-24 16:08:30 -07:00
Martin Braun
f98dbea429 mpm: e3xx: Fix inheritance order for DB classes
The classes E31x_db and Neon were importing the AD936xDboard mixin class
after their parent class, not before. This means the mixin couldn't be
used to override classes from the parent class, because Python's MRO
will go to the first class in the inheritance list.

Because there is no use of super() in these classes, the reordering has
no other effect than prioritize AD936xDboard over DboardManagerBase when
it comes to resolving parent methods.
2023-03-24 16:08:30 -07:00
Martin Braun
01ccb69459 mpm: x4xx: Move MB CPLD creation to factory
Main changes:
- x4xx_mb_cpld.MboardCPLD is renamed to X4xxMboardCPLD and is now a base
  class. Specific implementations of the MB CPLD require derived classes
  and have to provide their corresponding signature.
- In x4xx.py, we don't init the MB CPLD and then assert we have
  a specific signature. Instead, we init the MB CPLD, and choose
  a derived class based on the signature. If there is no such class,
  then the same error is generated as before (by itself, this means
  there is no behavioural change).
- The MB CPLD image for the X410 (ZBX daughterboards) is moved to
  a derived class X410MboardCPLD.
- New: The ZBX daughterboard driver verifies that the MB CPLD image is
  in fact compatible with the daughterboard. For this, the MB CPLD
  control classes require a COMPATIBLE_DB_PIDS attribute.

By itself, this change has no behavioural- or API changes. However, it
allows easily slotting in new CPLD images with different signatures.
Without further modifications, it does not allow *any* CPLD image
though: The PS API (e.g., enable/disable daughterboards, CMI status,
etc.) remain the same.
2023-03-09 11:10:39 -05:00
Martin Braun
4b007c42b3 mpm: x4xx: mb_cpld: Add missing bitfields
For the sake of completeness, the bitfields and register offsets defined
for interacting with the MB CPLD are matched with the HDL definitions,
even for registers that aren't being used by MPM at this moment.
2023-03-09 11:10:39 -05:00
Martin Braun
f97ca3d80c mpm: x4xx: Move common DB tasks from ZBX class to mixin
This adds a new class, X4xxDbMixin, which can be used for daughterboards
that are installed into an X4xx motherboard. It collects all the common
tasks between such daughterboards.

The mixin is also mixed into the ZBX daughterboard class. The other
dboards (IF test CCA, Debug DB) are not modified.
2023-03-08 16:18:08 -05:00
Martin Braun
507536d3f5 mpm: dboard_manager: Fix linter issues in dboard_manager/base.py 2023-03-08 16:18:08 -05:00
Martin Braun
119c28e5c7 mpm: bist: Improve --help message 2023-03-06 11:51:46 -05:00
Martin Braun
3113054712 mpm: periph_manager: Remove vestigial Python-six 2023-03-06 11:00:52 -05:00
Martin Braun
4cad444604 mpm: Move get_dboard_class_from_pid()
Move get_dboard_class_from_pid() from periph_manager/base.py to
periph_manager/__init__.py. This allows usage of that class elsewhere.
2023-03-06 11:00:52 -05:00
Martin Braun
e60f524647 mpm: x4xx: Remove get_cal_eeprom_spi_node()
This API call does nothing useful, is never called, and references
non-existant attributes of the x4xx class (qspi_cs, qspi_nodes). Most
likely this was used during early revisions of X410 development and
controlled hardware that no longer exists.
2023-03-02 09:01:40 -05:00
Wade Fife
e9590ce238 mpm: x4xx: Add UC FPGA type 2023-02-24 08:07:17 -06:00
Martin Braun
21107ff36c mpm: Fix test utilities
- Fix MockGpiod object: This class should mock the gpiod module, but it was
  missing the LINE_REQ_EV_FALLING_EDGE attribute.
- While we're at it, fix some pylint warnings.
2023-02-08 16:59:34 -06:00