Get OpenOCDDriver instance from pytest

[nvincent-vossloh]

Hello,

I am trying to get an OpenOCDDriver instance in order to be able to load the firmware on my device from a pytest fixture.

However with the following fixture (or when called directly from my test):

def openocddriver(target):
    yield target.get_driver('OpenOCDDriver')

I have the following error when running pytest

        if waiting:
>           raise NoResourceFoundError(
                f"Not all resources are {'available' if avail else 'unavailable'}: {waiting}",
                filter=waiting
            )
E           labgrid.exceptions.NoResourceFoundError: Not all resources are available: {USBDebugger(target=Target(name='main', env=Environment(config_file='vad-zephyr-nodes/lg_pmdb.yaml')), name=None, state=<BindingState.bound: 1>, avail=False, timeout=5.0, match=OrderedDict([('ID_PATH', 'pci-0000:08:00.0-usb-0:1.2'), ('SUBSYSTEM', 'usb')]), device=None)}

/home/nicolas/.virtualenvs/vad-lg/lib/python3.10/site-packages/labgrid/target.py:100: NoResourceFoundError

Here is the content of my target yaml env file:

tools:
  openocd: '/opt/zephyr-sdk-0.16.8/sysroots/x86_64-pokysdk-linux/usr/bin/openocd'
targets:
  main:
    resources:
      - RawSerialPort:
          name: shell_zephyr
          port: /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTAD1ABG-if00-port0
      - USBDebugger:
          match:
            ID_PATH: pci-0000:08:00.0-usb-0:1.2

    drivers:
      - SerialDriver:
          name: shell_zephyr_driver
          txdelay: 0.001
          bindings:
            port: shell_zephyr
      - OpenOCDDriver:
          config: 'boards/vossloh/pmdb/support/openocd.cfg'
          search: 'boards/vossloh/pmdb/support'
          load_commands:
            - 'init'
            - 'targets'
            - 'reset init'
            - 'flash write_image erase {filename}'
            - 'reset run'
            - 'shutdown'

And now for the weird part, when I try this in a standalone python console, it works fine:

In [1]: from labgrid import Environment    
    
In [2]: env = Environment('/home/nicolas/work/siema/be/VAD/src/vad-zephyr/vad-zephyr-nodes/lg_pmdb.yaml')    
    
In [3]: t = env.get_target('main')    
    
In [4]: ocd = t.get_driver('OpenOCDDriver')    
resources=[USBDebugger(target=Target(name='main', env=Environment(config_file='/home/nicolas/work/siema/be/VAD/src/vad-zephyr/vad-zephyr-nodes/lg_pmdb.yaml')), name=None, state=<BindingState.bound: 1>, avail=True, timeout=5.0, match=OrderedDict([('ID_PATH', 'pci-0000:08:00.0-usb-0:1.2'), ('SUBSYSTEM', 'usb')]), device=Device('/sys/devices/pci0000:00/0000:00:1c.2/0000:08:00.0/usb3/3-1/3-1.2'))]
resources=[]    
    
In [5]: ocd.load('twister-vad_apps/pmdb/fat_m007/fat_m007.defaults/zephyr/zephyr.hex')    
Open On-Chip Debugger 0.11.0+dev-00728-gb6f95a16c (2024-05-29-12:13)    
Licensed under GNU GPL v2    
For bug reports, read    
        http://openocd.org/doc/doxygen/bugs.html    
adapter usb location: 3-1.2    
    
Info : The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD    
Info : clock speed 500 kHz    
Info : STLINK V2J43S7 (API v2) VID:PID 0483:3748    
Info : Target voltage: 2.938936    
Info : [stm32l4x.cpu] Cortex-M4 r0p1 processor detected    
Info : [stm32l4x.cpu] target has 6 breakpoints, 4 watchpoints    
Info : starting gdb server for stm32l4x.cpu on 3333    
Info : Listening on port 3333 for gdb connections    
    TargetName         Type       Endian TapName            State    
--  ------------------ ---------- ------ ------------------ ------------    
 0* stm32l4x.cpu       hla_target little stm32l4x.cpu       running    
    
Info : Unable to match requested speed 500 kHz, using 480 kHz    
Info : Unable to match requested speed 500 kHz, using 480 kHz    
target halted due to debug-request, current mode: Thread    
xPSR: 0x01000000 pc: 0x08005b54 msp: 0x20006f40    
Info : device idcode = 0x100f6470 (STM32L4R/L4Sxx - Rev W : 0x100f)    
Info : RDP level 0 (0xAA)    
Info : flash size = 1024kbytes    
Info : flash mode : dual-bank    
Info : Padding image section 0 at 0x0801dacc with 4 bytes (bank write end alignment)    
Warn : Adding extra erase range, 0x0801dad0 .. 0x0801dfff    
auto erase enabled    
wrote 121552 bytes from file /home/nicolas/work/siema/be/VAD/src/vad-zephyr/twister-vad_apps/pmdb/fat_m007/fat_m007.defaults/zephyr/zephyr.hex in 2.213377s (53.630 KiB/s)    
    
Info : Unable to match requested speed 500 kHz, using 480 kHz    
Info : Unable to match requested speed 500 kHz, using 480 kHz    
shutdown command invoked

The probe is an st-link v2, I got ID_PATH line with labgrid-suggest after modifying labgrid/resource/udev.py to add

                         ("0483", "3748"),  # STLINK-V2

I don't understand what I am doing wrong here, according to the documentation, it looks like I am doing the proper thing.
Let me know if you need more information.

[nvincent-vossloh]

Ok I understand what I did wrong, I had multiple python virtual env, and the one I used with pytest did not have the modification in labgrid to specify the usb id code of the stlinkv2, after installing the modified labgrid into the virtual env used to run pytest it works fine.

Do you want me to file a PR ?

[Emantor]

Yes, please open a PR with the STLink id.

[nvincent-vossloh]

Hi, I just opened #1518