Skip to content
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

Jump to bottom

drivers/sdcard_spi: small cleanup #19527

Merged
merged 2 commits into from
May 2, 2023
Merged

drivers/sdcard_spi: small cleanup #19527

merged 2 commits into from
May 2, 2023

Conversation

gschorcht
Copy link
Contributor

@gschorcht gschorcht commented May 1, 2023 •
edited
Loading

Contribution description

This PR provides a small cleanup:

  • the copy of sdcard_spi_params_t is removed (commit bfc2a51)
  • the documentation was changed to fit the 100 characters per line. (commit 36f0162)

It is not necessary to hold a complete copy sdcard_spi_params_t in the device descriptor. Constant parameters can be used directly from ROM instead. This saves 24 bytes of RAM.

Testing procedure

Use any board with SD Card SPI interface. The driver test should still work, for example:

BOARD=esp32-wrover-kit make -j8 -C tests/driver_sdcard_spi flash term

main(): This is RIOT! (Version: 2023.07-devel-176-g7213c-drivers/sdcard_spi_cleanup)
SD-card spi driver test application
insert SD-card and use 'init' command to set card to spi mode
WARNING: using 'write' or 'copy' commands WILL overwrite data on your sd-card and
almost for sure corrupt existing filesystems, partitions and contained data!
> init
Initializing SD-card at SPI_0...
[OK]
>

Issues/PRs references

gschorcht added 2 commits May 1, 2023 14:36
@gschorcht
drivers/sdcard_spi: remove copy of sdcard_spi_params_t from device
bfc2a51 
It is not necessary to hold a complete copy `sdcard_spi_params_t` in the device descriptor. Constant parameters can be used directly from ROM instead. This saves 24 bytes of RAM.
@gschorcht
drivers/sdcard_spi: doc cleanup to fit in 100 characters per line
36f0162
@github-actions github-actions bot added the Area: drivers Area: Device drivers label May 1, 2023
@gschorcht gschorcht added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels May 1, 2023
@riot-ci
Copy link

riot-ci commented May 1, 2023

Murdock results

✔️ PASSED

36f0162 drivers/sdcard_spi: doc cleanup to fit in 100 characters per line

Success Failures Total Runtime
6931 0 6931 10m:06s

Artifacts

@benpicco
Copy link
Contributor

benpicco commented May 2, 2023

bors merge

@bors
Copy link
Contributor

bors bot commented May 2, 2023

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot merged commit c4b27d8 into RIOT-OS:master May 2, 2023
@gschorcht
Copy link
Contributor Author

Thanks

@benpicco benpicco added this to the Release 2023.07 milestone Aug 2, 2023
@gschorcht gschorcht deleted the drivers/sdcard_spi_cleanup branch September 10, 2023 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benpicco benpicco benpicco approved these changes

Assignees
No one assigned
Labels
Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Milestone
Release 2023.07
Development

Successfully merging this pull request may close these issues.
3 participants
@gschorcht @riot-ci @benpicco