Skip to content

feat(U-Boot): Add OTP Key Writer User Guide#703

Open
Harsha-VM wants to merge 4 commits into
TexasInstruments:masterfrom
Harsha-VM:am62l_enc_kw_docs
Open

feat(U-Boot): Add OTP Key Writer User Guide#703
Harsha-VM wants to merge 4 commits into
TexasInstruments:masterfrom
Harsha-VM:am62l_enc_kw_docs

Conversation

@Harsha-VM

Copy link
Copy Markdown
Contributor

Add a KeyWriter guide describing the procedure to program customer keys into the eFuses using U-Boot's fuse writebuff command, enabling HS-FS to HS-SE device conversion.

The guide covers:

  • Background on HS-FS and HS-SE device sub-types
  • The fuse_otp binary blob structure with a diagram illustrating the layout
  • Step-by-step key writer example flow
  • Post-programming note that eFuse changes require a full SoC power cycle to take effect

Register the new page in the AM62LX Linux TOC and U-Boot Users Guide index.

@sadik-smd

Copy link
Copy Markdown
Contributor

@shiva-ti @jsuhaas22 to review

@Harsha-VM
Harsha-VM marked this pull request as draft May 13, 2026 09:19
@StaticRocket

Copy link
Copy Markdown
Member

@Harsha-VM this was opened as a draft and never marked ready for review. Is there any additional pending work for this or should it go through proper review now?

@Harsha-VM
Harsha-VM marked this pull request as ready for review June 22, 2026 06:48
@Harsha-VM

Copy link
Copy Markdown
Contributor Author

@Harsha-VM this was opened as a draft and never marked ready for review. Is there any additional pending work for this or should it go through proper review now?

@StaticRocket Marked it ready for review now

@StaticRocket

Copy link
Copy Markdown
Member

What's actually the difference between Key Writer Lite and Key Writer ? The two files are almost exactly the same. This just seems to explicitly change the i2c dev to 2 instead of 1 for AM62L specifically. Seems odd.

@cshilwant

Copy link
Copy Markdown
Member

@shiva-ti @jsuhaas22 for review

@Harsha-VM

Copy link
Copy Markdown
Contributor Author

What's actually the difference between Key Writer Lite and Key Writer ? The two files are almost exactly the same.

@StaticRocket These are 2 different methods of secure key provisioning offered by TIFS. Keywriter Lite is used to convert the device to a HS-SE lite device(without encryption support) where Keywriter is used to convert the device to a HS-SE device(with encryption support). So, the structure layout and method of preparation differ between the both.

This just seems to explicitly change the i2c dev to 2 instead of 1 for AM62L specifically. Seems odd.

On this, 1 is the right bus, and it has been updated in the keywriter lite doc as well!

@StaticRocket

Copy link
Copy Markdown
Member

@Harsha-VM could we add this information to the introduction paragraph? I feel like that's an important distinction to make up front. Also, there's currently mixed use of key writer and keywriter. The TI-SCI documentation has a similar problem. What did we actually call this?

@StaticRocket

Copy link
Copy Markdown
Member

@liubiin this also feels like it's reaching into academy territory as it's more of a how-to guide

@Harsha-VM

Harsha-VM commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

@Harsha-VM could we add this information to the introduction paragraph? I feel like that's an important distinction to make up front. Also, there's currently mixed use of key writer and keywriter. The TI-SCI documentation has a similar problem. What did we actually call this?

@StaticRocket This information is already included in the High Security device sub types introductory section which comes up right at the start and how keywriter helps in the conversion of the same. The right word to use is keywriter, updating the PR to consistently use that!

@Harsha-VM
Harsha-VM force-pushed the am62l_enc_kw_docs branch from cd3fdb2 to 24a4ec3 Compare July 15, 2026 06:41
Comment thread source/linux/Foundational_Components/U-Boot/UG-Keywriter.rst
@Harsha-VM
Harsha-VM force-pushed the am62l_enc_kw_docs branch from 24a4ec3 to 491a483 Compare July 17, 2026 06:31
shiva-ti
shiva-ti previously approved these changes Jul 17, 2026

@shiva-ti shiva-ti left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@Harsha-VM
Harsha-VM force-pushed the am62l_enc_kw_docs branch from 491a483 to e213519 Compare July 20, 2026 08:54
@StaticRocket

Copy link
Copy Markdown
Member

Please add the proper spelling and case of Keywriter to vale. https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#vale-grammar-spelling-and-prose-checking

Ensure that only the official case an spelling is used in this document please.

Vale flags "Keywriter"/"keywriter" as a misspelling. Add it to the
custom vocabulary so both cases are accepted.

Signed-off-by: Harsha Vardhan V M <h-vm@ti.com>
Add a Keywriter guide describing the procedure to program
customer keys into the eFuses using U-Boot's `fuse writebuff`
command, enabling HS-FS to HS-SE device conversion.

The guide covers:
- Background on HS-FS and HS-SE device sub-types
- The fuse_otp binary blob structure with a diagram
  illustrating the layout
- Step-by-step key writer example flow
- Post-programming note that eFuse changes require a full SoC
  power cycle to take effect

Register the new page in the AM62LX Linux TOC and U-Boot Users Guide
index.

Signed-off-by: Harsha Vardhan V M <h-vm@ti.com>
Replace the generic "Key Management" entry with two separate rows detailing
OTP Keywriter and OTP Keywriter Lite (without encryption support) to better
clarify their distinct purposes and capabilities.

Signed-off-by: Harsha Vardhan V M <h-vm@ti.com>
Rename UG-Key-Writer-Lite.rst to UG-Keywriter-Lite.rst and its ref
label (key-writer-lite-label -> keywriter-lite-label) to match the
official "Keywriter" spelling. Update all "Key Writer Lite" spacing
variants in the doc body to "Keywriter Lite"/"keywriter lite", and
fix references in Security_overview.rst, UG-Programming-OTPs.rst,
Users-Guide.rst, and AM62LX_linux_toc.txt accordingly.

Signed-off-by: Harsha Vardhan V M <h-vm@ti.com>
@Harsha-VM
Harsha-VM force-pushed the am62l_enc_kw_docs branch from 093e74f to 422f924 Compare July 21, 2026 10:45
@Harsha-VM

Copy link
Copy Markdown
Contributor Author

Please add the proper spelling and case of Keywriter to vale. https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#vale-grammar-spelling-and-prose-checking

Ensure that only the official case an spelling is used in this document please.

@StaticRocket Done, please check!

@StaticRocket

Copy link
Copy Markdown
Member

Huh. I guess we don't have a trademark on that term so the case is less important. Sure

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.