aboutsummaryrefslogtreecommitdiffstats
path: root/mpm/python/usrp_mpm/dboard_manager/magnesium.py
blob: 612705ce4d09002d4037109af9de5f6c227cbe9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
#
# Copyright 2017 Ettus Research (National Instruments)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
"""
magnesium dboard implementation module
"""

import struct
import time
from six import iteritems
from . import lib # Pulls in everything from C++-land
from .base import DboardManagerBase
from .. import nijesdcore
from ..uio import UIO
from ..mpmlog import get_logger
from .lmk_mg import LMK04828Mg

def create_spidev_iface(dev_node):
    """
    Create a regs iface from a spidev node
    """
    SPI_SPEED_HZ = 1000000
    SPI_ADDR_SHIFT = 8
    SPI_DATA_SHIFT = 0
    SPI_READ_FLAG = 1<<23
    SPI_WRIT_FLAG = 0
    return lib.spi.make_spidev_regs_iface(
        dev_node,
        SPI_SPEED_HZ,
        SPI_ADDR_SHIFT,
        SPI_DATA_SHIFT,
        SPI_READ_FLAG,
        SPI_WRIT_FLAG
    )

class Magnesium(DboardManagerBase):
    """
    Holds all dboard specific information and methods of the magnesium dboard
    """
    #########################################################################
    # Overridables
    #
    # See DboardManagerBase for documentation on these fields
    #########################################################################
    pids = [0x150]

    # Maps the chipselects to the corresponding devices:
    spi_chipselect = {"lmk": 0, "mykonos": 1}

    def __init__(self, slot_idx, **kwargs):
        super(Magnesium, self).__init__(*args, **kwargs)
        self.log = get_logger("Magnesium")
        spi_devices = kwargs['spi_nodes']
        # eeprom_data is a tuple (head_dict, raw_data)
        if len(spi_devices) != len(self.spi_chipselect):
            self.log.error("Expected {0} spi devices, found {1} spi devices".format(
                len(self.spi_chipselect), len(spi_devices),
            ))
            raise RuntimeError("Not enough SPI devices found.")
        self._spi_nodes = {}
        for k, v in iteritems(self.spi_chipselect):
            self._spi_nodes[k] = spi_devices[v]
        self.log.debug("spidev device node map: {}".format(self._spi_nodes))

    def init_device(self):
        """
        Execute necessary init dance to bring up dboard
        """
        self.clock_regs = create_spidev_iface(self._spi_nodes['lmk'])
        self.log.debug("Loading C++ drivers...")
        self._device = lib.dboards.magnesium_manager(
            self._spi_nodes['mykonos'],
        )
        self.spi_lock = self._device.get_spi_lock()
        self.mykonos = self._device.get_radio_ctrl()
        self.log.debug("Loaded C++ drivers.")
        self.lmk = LMK04828Mg(self.clock_regs, self.spi_lock)

        self.log.debug("Getting Mg A uio...")
        self.radio_regs = UIO(label="jesd204b-regs", read_only=False)
        self.log.info("Radio-register UIO object successfully generated!")
        self.init_jesd(self.radio_regs)

    def init_jesd(self, uio):
        """
        Bring up the JESD link between Mykonos and the N310
        """
        self.log.trace("Creating jesdcore object")
        self.jesdcore = nijesdcore.NIMgJESDCore(uio)

        self.log.trace("Checking JESD core...")
        self.jesdcore.check_core()
        self.log.trace("Initializing LMK...")
        self.lmk.init()
        self.radio_regs.poke32(0x2078, 0xA000040)
        self.log.trace("Verify LMK Chip ID...")
        self.lmk.verify_chip_id()

        self.jesdcore.unreset_mmcm()

        self.jesdcore.init()
        self.log.trace("Resetting Mykonos...")
        self.jesdcore.reset_mykonos() #not sure who owns the reset

        self.log.trace("Initializing Mykonos...")
        self.mykonos.begin_initialization()
        self.jesdcore.send_sysref_pulse()
        self.jesdcore.send_sysref_pulse()
        self.mykonos.finish_initialization()

        self.log.trace("Starting Mykonos framer...")
        self.mykonos.start_jesd_rx()
        self.jesdcore.send_sysref_pulse()
        self.log.trace("Resetting FPGA deframer...")
        self.jesdcore.init_deframer()
        self.log.trace("Resetting FPGA framer...")
        self.jesdcore.init_framer()
        self.log.trace("Starting Mykonos deframer...")
        self.mykonos.start_jesd_tx()

        self.log.trace("Enable LMFC and send")
        self.jesdcore.enable_lmfc()
        self.jesdcore.send_sysref_pulse()
        time.sleep(0.2)
        if not self.jesdcore.get_framer_status():
            raise Exception('JESD Core Framer is not synced!')
        if not self.jesdcore.get_deframer_status():
            raise Exception('JESD Core Deframer is not synced!')
        if (self.mykonos.get_framer_status() & 0xFF != 0x3E):
            raise Exception('Mykonos Framer is not synced!')
        if (self.mykonos.get_deframer_status() & 0x7F != 0x28):
            raise Exception('Mykonos Deframer is not synced!')
        self.log.trace("JESD fully synced and ready")

    def dump_jesd_core(self):
        for i in range(0x2000, 0x2110, 0x10):
            print("0x%04X " % i),
            for j in range(0, 0x10, 0x4):
                print("%08X" % self.radio_regs.peek32(i + j)),
            print("")

    def read_eeprom_v1(self, data):
        """
        read eeprom data version 1
        """
        # magnesium eeprom contains
        # nothing
        return struct.unpack_from("x", data)