-
Notifications
You must be signed in to change notification settings - Fork 3k
Check in files for the FPGA CI Test Shield #10540
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.
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
Conversation
Bring all the FPGA CI Test Shield C and C++ driver files into mbed-os as the component FPGA_CI_TEST_SHIELD. When this component is enabled all the files that are needed to communicate with, update firmware on and run testing with the FPGA are built.
@c1728p9, thank you for your changes. |
And fix any build errors this caused.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
initial review comments
#include "platform/Callback.h" | ||
#include "drivers/DigitalInOut.h" | ||
|
||
class MbedTester { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would it be worth documenting this class (for instance as SPI class has some example and description). Isn't this the most important object for this shield?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added some documentation and example code.
std::list<PortType> matched_ports, not_matched_ports; | ||
find_ports<PortType, FormFactorType>(matched_ports, not_matched_ports); | ||
|
||
utest_printf("***Testing one %s pin configuration***\n", PortType::PinMap::name); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why do we use utest_printf
and not stdout?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is a test utility shouldn't it use the utest_printf? @maciejbocianski can you comment on this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exactly, this utility code is intended to be used in tests only, this is why utest_printf
was used
} | ||
}; | ||
|
||
#if DEVICE_SPI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we describe here with a comment what these peripherals utils mean (if I add here, what should I add? ) - small description would help
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added documentation to this.
return true; | ||
} | ||
|
||
class DefaultFormFactor { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've noticed these utils are not much documented in this header file - what this defaultformfactor does ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added documentation to this.
Run astyle to correct formatting.
1fd7b1a
to
45301ea
Compare
Add documentation to the MbedTester class and the test_utils.h file.
Mbed OS CI won't be able to test this until the component FPGA_CI_TEST_SHIELD is added. To get some testing in I created a test branch where this is no longer a component and therefore built as part of CI and manually triggered a CI job on this branch. |
I've started first test job for this. |
internal CI fault, restarting IC |
Test run: FAILEDSummary: 1 of 11 test jobs failed Failed test jobs:
|
CI started |
Test run: SUCCESSSummary: 11 of 11 test jobs passed |
It is almost ready, any more reviews done ?
@OPpuolitaival Can this be added? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. One thing I'd like to see is docs how to use it. I know that HW is not yet publicly available, but we'll need the docs soon anyway.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Bring in updates the the FPGA CI Test Shield repo.
Added some changes that came in since this PR was created. This should be ready for re-test and merge. |
Ci restarted |
@maciejbocianski @c1728p9 Please make sure there is documentation added for this one. This is ready for merging once CI is done |
Test run: SUCCESSSummary: 11 of 11 test jobs passed |
Description
Bring all the FPGA CI Test Shield C and C++ driver files into mbed-os as the component FPGA_CI_TEST_SHIELD. When this component is enabled all the files that are needed to communicate with, update firmware on and run testing with the FPGA are built.
Pull request type
Reviewers
@mrcoulter45 @maciejbocianski @mprse @fkjagodzinski @0xc0170 @jamesbeyond @donatieng @OPpuolitaival
Release Notes
Added files to control the FPGA CI Test Shield. This allows for enhanced testing.