Skip to content

Fixing LinuxSpiDriver issues; Adding function argument check and completing read-after-write checks #4137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Sep 11, 2025
Merged

Fixing LinuxSpiDriver issues; Adding function argument check and completing read-after-write checks #4137

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3275b15
Fixing read-after-write checks for SPI configuration. Adding UT.
vincewoo Jul 30, 2025
c3569f7
Merge branch 'devel' into FP-3478
vincewoo Sep 4, 2025
9757c30
Merge branch 'devel' into FP-3478
vincewoo Sep 4, 2025
267dc4f
Merge branch 'devel' into FP-3478
vincewoo Sep 10, 2025
b24db26
Add assert to validate the read and write buffers are the same size i…
vincewoo Sep 10, 2025
73a5533
Corrected WARNING_LOW -> WARNING_LO
vincewoo Sep 10, 2025
c2b4404
Fixing event Strings and invalid SpiFrequency
vincewoo Sep 10, 2025
49c4848
Reverting changes to LinuxSpiDriverTester
vincewoo Sep 10, 2025
9409bae
Removing redundant variable write_clock
vincewoo Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions Drv/LinuxSpiDriver/Events.fppi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@ event SPI_WriteError(
format "Error writing/reading SPI device {}.{}: {}" \
throttle 5

@ SPI configuration mismatch
event SPI_ConfigMismatch(
device: I32 @< The device
select: I32 @< The chip select
parameter: string @< The parameter being configured
write_value: U32 @< The value written
read_value: U32 @< The value read
) \
severity warning low \
id 3 \
format "SPI device {}.{} configuration mismatch for {}: wrote {}, read {}"

@ SPI open notification
event SPI_PortOpened(
device: I32 @< The device
Expand Down
27 changes: 23 additions & 4 deletions Drv/LinuxSpiDriver/LinuxSpiDriverComponentImpl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Assert.hpp>
#include <Fw/Types/FileNameString.hpp>
#include <Fw/Types/String.hpp>
#include <cerrno>
#include <cstdint>
#include <cstdio>
Expand All @@ -36,6 +37,8 @@
void LinuxSpiDriverComponentImpl::SpiReadWrite_handler(const FwIndexType portNum,
Fw::Buffer& writeBuffer,
Fw::Buffer& readBuffer) {
FW_ASSERT(writeBuffer.getSize() == readBuffer.getSize());

if (this->m_fd == -1) {
return;
}
Expand Down Expand Up @@ -120,12 +123,17 @@
return false;
}

ret = ioctl(fd, SPI_IOC_RD_MODE, &mode);
U8 read_mode = 0;
ret = ioctl(fd, SPI_IOC_RD_MODE, &read_mode);
if (ret == -1) {
this->log_WARNING_HI_SPI_ConfigError(device, select, ret);
return false;
}

if (mode != read_mode) {
this->log_WARNING_LO_SPI_ConfigMismatch(device, select, Fw::String("MODE"), mode, read_mode);
}

/*
* 8 bits per word
*/
Expand All @@ -136,27 +144,38 @@
return false;
}

ret = ioctl(fd, SPI_IOC_RD_BITS_PER_WORD, &bits);
U8 read_bits = 0;
ret = ioctl(fd, SPI_IOC_RD_BITS_PER_WORD, &read_bits);
if (ret == -1) {
this->log_WARNING_HI_SPI_ConfigError(device, select, ret);
return false;
}

if (bits != read_bits) {
this->log_WARNING_LO_SPI_ConfigMismatch(device, select, Fw::String("BITS_PER_WORD"), bits, read_bits);
}

/*
* Max speed in Hz
*/
ret = ioctl(fd, SPI_IOC_WR_MAX_SPEED_HZ, &clock);
SpiFrequency write_clock = clock;
ret = ioctl(fd, SPI_IOC_WR_MAX_SPEED_HZ, &write_clock);
if (ret == -1) {
this->log_WARNING_HI_SPI_ConfigError(device, select, ret);
return false;
}

ret = ioctl(fd, SPI_IOC_RD_MAX_SPEED_HZ, &clock);
SpiFrequency read_clock;
ret = ioctl(fd, SPI_IOC_RD_MAX_SPEED_HZ, &read_clock);
if (ret == -1) {
this->log_WARNING_HI_SPI_ConfigError(device, select, ret);
return false;
}

if (clock != read_clock) {
this->log_WARNING_LO_SPI_ConfigMismatch(device, select, Fw::String("MAX_SPEED_HZ"), clock, read_clock);
}

return true;
}

Expand Down
Loading