Skip to content

NFC EEPROM driver porting guide #669

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

Merged
merged 6 commits into from
Aug 30, 2018

Conversation

paul-szczepanek-arm
Copy link
Member

No description provided.

@MarceloSalazar
Copy link
Contributor

Thanks for sharing this. It's looking good :)

Is there a top-level NFC porting guide?
I understand 'EEPROM' is one "flavor" of an NFC implementation. If there is no other doc, I'd suggest making the NFC porting guide a bit more generic, and have a case for EEPROM. There might be cases in the future for Flash, SPI, RAM, or whatever memory.

Also, It would be great to have a link to the draft Technology doc, developer API, and example app asap, so we can review and provide feedback before OOB week.

@paul-szczepanek-arm
Copy link
Member Author

No, this is the first porting guide afaik. This is a porting guide just for the driver.

API, example and everything else is still in the works. This porting guide is limited to porting of the driver.

@MarceloSalazar
Copy link
Contributor

Ok, I'll wait for other docs to come, as I need more background to review this PR.
I feel I'm missing context on what we plan to support & publish.

@paul-szczepanek-arm
Copy link
Member Author

This porting guide is self contained, although it's dependent on the NFC implementation landing on mbed-os first - otherwise there is nothing for porters to port.

Copy edit file, mostly for active voice and U.S. spelling

Run the tests with:

`mbed test -m [mcu] -t [toolchain] -n tests-nfc-eeprom*`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query: Is there any defined or undefined behavior we want to call out in its own section? Also, are there any dependencies we want to call out in their own section?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't think of anything. Do want me to clarify anything in particular?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. All of the HAL target porting guides have defined and undefined behavior sections as part of their template. The connectivity porting guides don't, so this doesn't require them. But if there were something we should call out, I wanted to make sure we did.

@AnotherButler
Copy link
Contributor

ping @pan-

@AnotherButler
Copy link
Contributor

ping @paul-szczepanek-arm

Add unique heading ID for linking best practices.
@AnotherButler AnotherButler merged commit 24f801d into ARMmbed:development Aug 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants