Skip to content

Update crypto driver documentation - #804

Open
Pratham-T wants to merge 2 commits into
TexasInstruments:masterfrom
Pratham-T:cryptodocs
Open

Pratham-T wants to merge 2 commits into
TexasInstruments:masterfrom
Pratham-T:cryptodocs

Conversation

@Pratham-T

Copy link
Copy Markdown
Contributor

As was discussed in #544 (comment), the long term plan was to merge DTHEv2 and SA2UL/OMAP kernel driver doc into one back again. DTHEv2 was split into a different file as in the earlier releases, the feature enablement difference caused huge chunks of the page hidden behind ifconfigs. As we moved eventually to enable all features of DTHEv2, the difference has reduced.

Now, this commit adds IPSec documentation for DTHEv2, after which both the documentation pages are essentially same with different device names. So, instead, finally, merge these two into a single page back again. Also do some aesthetic changes.

One caveat is that the "Crypto Implementations Options" subsection added sometime in the previous release has this: see :ref:`crypto-performance` in the Linux Performance Guide. The crypto-performance page does not exist for all platforms. For those, this would not render a hyperlink and throw a build time warning. @jsuhaas22, @shiva-ti since these were added in your PRs, are you aware of this and are you planning on creating an automated script to populate the performance table in each release?

CC: @manorit2001 @ti-kamlesh for review.

DTHEv2 has now enabled all fetaures available with SA2/3UL. The crypto
docs were initially split on the introduction of DTHEv2 since a large
part of it was hidden with bunch of ifconfigs. Usage and testing wise,
both hardware accelerators don't differ much and the parity in the docs
was only because of staggered feature enablement in DTHEv2. The final
section missing from DTHEv2 was IPSec testing. With DTHEv2 now
supporting that as well, the doc is nearly identical with SA2UL. So, now
merge the SA2UL_OMAP.rst and DTHEv2.rst back into Crypto.rst. Change the
necessary tocs as well.

Signed-off-by: T Pratham <t-pratham@ti.com>
AM57X config has been setting CRYPTO_config to empty string. Change it
to omap. Next, split the supported hardware crypto table in crypto
driver docs to separate SA2/3UL and OMAP devices into different tables.

Signed-off-by: T Pratham <t-pratham@ti.com>
Copilot AI balanced review requested due to automatic review settings September 30, 2026 09:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@StaticRocket StaticRocket left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think I agree with this change. For future reference, you should use the refactor commit tag for reorganizing things like this if you avoid changing the content itself.

@cshilwant

Copy link
Copy Markdown
Member

+ @ti-kamlesh for reviews

@ti-kamlesh

Copy link
Copy Markdown
Contributor

LGTM

cc: @manorit2001

@manorit2001 manorit2001 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sa2ul might not have few things in 12.02 like GCM, HMAC etc as we are trying to upstream those, you can either remove those as a separate commit or i can take it up. Should be fine either ways.

LGTM

@Pratham-T

Copy link
Copy Markdown
Contributor Author

Sa2ul might not have few things in 12.02 like GCM, HMAC etc as we are trying to upstream those, you can either remove those as a separate commit or i can take it up. Should be fine either ways.

Would be better if you send a separate PR updating those. Thanks anyway for the review.

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.