Files
leonarski_fandClaude Opus 5.5 f3be10f279 acquisition_device: refuse internal generator images the card memory cannot hold
With modules x images at or above what the card's HBM holds for the
internal frame generator (64 module frames in the HLS simulation, 1024 on
the card), frame_generator refuses the run and sends nothing, and the
collection hung in Measuring with no error. The host now checks this:
PrepareAction refuses such a run at the start (a 32-bit EIGER frame
counts twice, as in frame_generator.cpp), and SetInternalGeneratorFrame
refuses an image that would land there, each with an error that says
how many module frames fit. The capacity comes from hbm_size_bytes of
the card's status (the mock keeps its 64).

The check keeps the last module frame free as well: load_calibration.cpp
accepts module_id == 2 * hbm_size_bytes / module size (">" where ">="
was meant), one past the memory. The firmware is frozen, so the host
never sends that index instead.

The HLS simulation keeps frame_generator's return code: a refused
configuration cancels the data collection rather than waiting for frames,
and HLSSimulatedDevice::FPGA_EndAction throws with the code.

rc184 has no MockAcquisitionDevice: its part is left out, and the test checks HLSSimulatedDevice only, as HLSSimulatedDevice_InternalGeneratorMemory in FPGAIntegrationTest.

(ported from rc184-2 25542a9af)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HVeDQsU5a8AJUdJPgWevAK
2026-11-08 20:08:27 +01:00

132 lines
3.9 KiB
C++

// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#include "PCIExpressDevice.h"
#include "../common/NetworkAddressConvert.h"
#define PCI_EXCEPT(x) try {x;} catch (const std::exception &e) { throw PCIeDeviceException(e.what()); }
PCIExpressDevice::PCIExpressDevice(uint16_t data_stream, uint16_t pci_slot) :
PCIExpressDevice(data_stream, "/dev/jfjoch" + std::to_string(pci_slot)) {}
PCIExpressDevice::PCIExpressDevice(uint16_t data_stream) :
PCIExpressDevice(data_stream, "/dev/jfjoch" + std::to_string(data_stream)) {}
PCIExpressDevice::PCIExpressDevice(uint16_t data_stream, const std::string &device_name)
: FPGAAcquisitionDevice(data_stream), dev(device_name, true) {
DataCollectionStatus status;
PCI_EXCEPT(status = dev.GetDataCollectionStatus())
max_modules = status.max_modules;
if (max_modules == 0)
throw JFJochException(JFJochExceptionCategory::PCIeError, "Max modules cannot be zero");
internal_generator_module_frames = GeneratorModuleFrames(status.hbm_size_bytes);
uint32_t num_buf = GetNumKernelBuffers();
buffer_device.resize(num_buf, nullptr);
try {
for (int i = 0; i < num_buf; i++)
buffer_device[i] = dev.MapKernelBuffer(i);
} catch (JFJochException &e) {
UnmapBuffers();
throw;
}
}
PCIExpressDevice::~PCIExpressDevice() {
UnmapBuffers();
}
void PCIExpressDevice::UnmapBuffers() {
for (auto &buf: buffer_device)
if (buf != nullptr) dev.UnmapKernelBuffer(buf);
}
bool PCIExpressDevice::HW_ReadMailbox(uint32_t *values) {
PCI_EXCEPT(return dev.ReadWorkCompletion(values);)
}
void PCIExpressDevice::Cancel() {
PCI_EXCEPT(dev.Cancel();)
}
bool PCIExpressDevice::HW_SendWorkRequest(uint32_t handle) {
PCI_EXCEPT(return dev.SendWorkRequest(handle);)
}
void PCIExpressDevice::FPGA_StartAction(const DiffractionExperiment &experiment) {
PCI_EXCEPT(dev.Start();)
}
void PCIExpressDevice::HW_RunInternalGenerator(const FrameGeneratorConfig &config) {
PCI_EXCEPT(dev.RunFrameGenerator(config);)
}
void PCIExpressDevice::FPGA_EndAction() {
PCI_EXCEPT(dev.End();)
}
bool PCIExpressDevice::HW_IsIdle() const {
PCI_EXCEPT(return dev.IsIdle();)
}
void PCIExpressDevice::HW_WriteActionRegister(const DataCollectionConfig *config) {
PCI_EXCEPT(dev.SetConfig(*config);)
}
void PCIExpressDevice::HW_ReadActionRegister(DataCollectionConfig *config) {
PCI_EXCEPT(*config = dev.GetConfig();)
}
std::string PCIExpressDevice::GetMACAddress() const {
PCI_EXCEPT(return MacAddressToStr(dev.GetMACAddress());)
}
uint32_t PCIExpressDevice::GetNumKernelBuffers() const {
PCI_EXCEPT(return dev.GetBufferCount();)
}
int32_t PCIExpressDevice::GetNUMANode() const {
PCI_EXCEPT(return dev.GetNumaNode();)
}
void PCIExpressDevice::SetIPv4Address(uint32_t ipv4_addr_network_order) {
PCI_EXCEPT(
// Configure all links with the same IPv4 address
auto dev_status = dev.GetDeviceStatus();
for (int i = 0; i < dev_status.eth_link_count; i++)
dev.SetIPv4Address(ipv4_addr_network_order, i);
dev.SetIPv4Address(ipv4_addr_network_order, NET_IF_FRAME_GENERATOR);
)
}
std::string PCIExpressDevice::GetIPv4Address() const {
PCI_EXCEPT(
return IPv4AddressToStr(dev.GetIPv4Address());
)
}
void PCIExpressDevice::HW_SetSpotFinderParameters(const SpotFinderParameters &params) {
PCI_EXCEPT(
dev.SetSpotFinderParameters(params);
)
}
DeviceStatus PCIExpressDevice::GetDeviceStatus() const {
PCI_EXCEPT(
return dev.GetDeviceStatus();
)
}
DataCollectionStatus PCIExpressDevice::GetDataCollectionStatus() const {
PCI_EXCEPT(
return dev.GetDataCollectionStatus();
)
}
void PCIExpressDevice::HW_LoadCalibration(const LoadCalibrationConfig &config) {
PCI_EXCEPT(dev.LoadCalibration(config);)
}