OP-TEE / optee_docs

This git contains the official documentation for the OP-TEE project
BSD 2-Clause "Simplified" License
58 stars 96 forks source link

core: using native interrupt handlers #215

Closed etienne-lms closed 12 months ago

etienne-lms commented 1 year ago

Adds a section in core architecture documentation to describe interrupt controllers API functions. These commits are based on stalled P-R https://github.com/OP-TEE/optee_docs/pull/192.

The 1st commit describes the API since https://github.com/OP-TEE/optee_os/pull/6354 has been merged. The 2nd commit is an RFC describing the API as per P-R https://github.com/OP-TEE/optee_os/pull/6361.

etienne-lms commented 12 months ago

I have remove the description related to P-R #6361, used a specific section for main controller info, rephrased a bit the description and add interrupt_call_handlers() info. I think this change should in next tag documentation.

etienne-lms commented 12 months ago

comments addressed.

jbech-linaro commented 12 months ago

Not sure why this pass on readthedocs, since I see both Error and warnings when looking that the readthedocs log. I noticed that when building this locally:

/home/jyx/devel/optee_projects/optee_docs/architecture/core.rst:419: ERROR: Unexpected indentation.
/home/jyx/devel/optee_projects/optee_docs/architecture/core.rst:411: ERROR: Unknown target name: "interrupt.h".
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
/home/jyx/devel/optee_projects/optee_docs/architecture/core.rst:468: WARNING: undefined label: '_notifications'
etienne-lms commented 12 months ago

Thanks @jbech-linaro. Indeed I forgot to test building the doc. Now it should be ok with the appended fixup commit.

etienne-lms commented 12 months ago

comments addressed

jbech-linaro commented 12 months ago

Thanks @etienne-lms

Reviewed-by: Joakim Bech <joakim.bech@linaro.org>

etienne-lms commented 12 months ago

@jenswi-linaro, I guess your review tag still applies.

jenswi-linaro commented 12 months ago

@jenswi-linaro, I guess your review tag still applies.

Yes :-)

etienne-lms commented 12 months ago

fixup commits squashed review tags applied thanks for the fixes