- Openamp-system-reference - lists.openampproject.org

Proposal for Updating Doxygen Comments within OpenAMP for Consistent Documentation of Input Parameters

by Leino, Tammy

Hello All, As per the discussion last week in the OpenAMP System Reference call, here is my proposal for updating the Doxygen comments for consistent documentation of input parameters. I would like to target these changes for the April 2023 release. I will be sending out another email with proposed changes for documenting data structures also targeting the April 2023 release. There are other changes I will be proposing for future releases, but these two proposals are what seem doable for April. Overview: ------------- 1 - Isolate all Doxygen comments to header files. Doxygen comments are currently sporadically located between source and header files. Some routines have Doxygen comments in both places. Zephyr has Doxygen comments for all functions/data structures in header files (except for static/externed functions), so the proposal is to follow their example. 2 - Update Doxygen comment formatting to be consistent. 3 - Ensure all i/o parameters for APIs are documented. Examples: -------------- Following shows just one example of each suggestion. #1 - Isolate all Doxygen comments to header files. ++++++++++++++++++++++++++++++++++++++ rpmsg_send_offchannel_raw() The Doxygen comments are found in both the header file and the source file. The formatting in the source file is proper, and is given priority when the code is built, so it is used and displayed properly in the html. Recommend to move the formatting to the header file. #2 - Update formatting to be consistent. ++++++++++++++++++++++++++++++ rpmsg_get_tx_payload_buffer() The Doxygen formatting is not proper for the input parameters and therefore does not display correctly. html output for input parameters is as follows: @ept: Pointer to rpmsg endpoint @len: Pointer to store tx buffer size @wait: Boolean, wait or not for buffer to become available This should instead be formatted as: Parameters ept Pointer to rpmsg endpoint len Pointer to store tx buffer size wait Boolean, wait or not for buffer to become available The changes to support this requirement are as follows: Current formatting: /** * @brief Gets the tx buffer for message payload. * * This API can only be called at process context to get the tx buffer in vring. * By this way, the application can directly put its message into the vring tx * buffer without copy from an application buffer. * It is the application responsibility to correctly fill the allocated tx * buffer by data and passing correct parameters to the rpmsg_send_nocopy() or * rpmsg_sendto_nocopy() function to perform data no-copy-send mechanism. * * @ept: Pointer to rpmsg endpoint * @len: Pointer to store tx buffer size * @wait: Boolean, wait or not for buffer to become available * * @return The tx buffer address on success and NULL on failure * * @see rpmsg_send_offchannel_nocopy * @see rpmsg_sendto_nocopy * @see rpmsg_send_nocopy */ void *rpmsg_get_tx_payload_buffer(struct rpmsg_endpoint *ept, uint32_t *len, int wait); Proposed updated formatting highlighted by ==>: /** * @brief Gets the tx buffer for message payload. * * This API can only be called at process context to get the tx buffer in vring. * By this way, the application can directly put its message into the vring tx * buffer without copy from an application buffer. * It is the application responsibility to correctly fill the allocated tx * buffer by data and passing correct parameters to the rpmsg_send_nocopy() or * rpmsg_sendto_nocopy() function to perform data no-copy-send mechanism. * ==> * @param ept Pointer to rpmsg endpoint ==> * @param len Pointer to store tx buffer size ==> * @param wait Boolean, wait or not for buffer to become available * * @return The tx buffer address on success and NULL on failure * * @see rpmsg_send_offchannel_nocopy * @see rpmsg_sendto_nocopy * @see rpmsg_send_nocopy */ void *rpmsg_get_tx_payload_buffer(struct rpmsg_endpoint *ept, uint32_t *len, int wait); #3 - Ensure all parameters are documented. ++++++++++++++++++++++++++++++++++ rpmsg_send_offchannel_raw() The Doxygen comments in the source file are complete, but the header file is missing some parameters. All routines should be checked for completeness. Comments respectfully appreciated. Thanks, Tammy

2 years, 5 months

2
1
0 0

2023-03-08 OpenAMP System Reference notes and action items

by Chan King Choy, Nathalie

Hi all, Notes are posted at https://github.com/OpenAMP/openamp-system-reference/wiki/OpenAMP-System-Ref… Let us know if you spot any errors or important omissions. Action items: * Hari to check with Nishanth if TI is approved for Linaro Connect * Nathalie: Start thread on email regarding OpenAMP F2F at Linaro Connect * Nathalie: Reach out to NXP OpenAMP folks to see if they are attending Linaro Connect Thanks & regards, Nathalie

2 years, 5 months

1
0
0 0

Calling for Agenda: 2023-03-08 OpenAMP System Reference

by Chan King Choy, Nathalie

Hi all, Please let us know your topics for this week's System Reference call. Here is what I have so far: * Linaro Connect: * Who submitted for the CFP & what topics? * Bill: OpenAMP BOF (Birds Of a Feather) * Arnaud: management of the coprocessor firmware in OP-TEE * Any updates on who is able to attend Connect? * Individual updates on OpenAMP System Reference-related work Thanks & regards, Nathalie

2 years, 5 months

1
0
0 0

2022-02-22 OpenAMP System Reference notes and action items

by Chan King Choy, Nathalie

Hi all, Sorry for the delay. Been tied up with a release in another project. Notes from last call are posted at: https://github.com/OpenAMP/openamp-system-reference/wiki/OpenAMP-System-Ref… Action items: * Bill to put on agenda for RP call in 2 weeks to discuss fixing up of API reference guide (requires touching a lot of files) * Nathalie to reach out to NXP to figure out which calls they want to participate in * Nathalie: Put in calendar reminders for Google Summer of Code consideration Best regards, Nathalie

2 years, 5 months

1
0
0 0

OpenAMP System Reference bi-weekly

by Chan King Choy, Nathalie

[Shortening to the 2nd half of the slot, as there is a one-off overlapping Linaro call for some of us in the first half] Meeting notes can be found at https://github.com/OpenAMP/openamp-system-reference/wiki/OpenAMP-System-Ref… [https://st2.zoom.us/static/6.3.10815/image/new/ZoomLogo_110_25.png]<https://zoom.us/> Hi there, Nathalie Chan King Choy is inviting you to a scheduled Zoom meeting. Join Zoom Meeting<https://xilinx.zoom.us/j/99873857206?pwd=RHBvSDgxWUgrMTc2cGpleTZlTTdsdz09&f…> Phone one-tap: US: +19292056099,,99873857206#,,,,,,0#,,9703966912#<tel:+19292056099,,99873857206#,,,,,,0#,,9703966912#> or +16699006833,,99873857206#,,,,,,0#,,9703966912#<tel:+16699006833,,99873857206#,,,,,,0#,,9703966912#> Meeting URL: https://xilinx.zoom.us/j/99873857206?pwd=RHBvSDgxWUgrMTc2cGpleTZlTTdsdz09&f… Meeting ID: 998 7385 7206 Passcode: 9hL+e9TMj8 Join by Telephone For higher quality, dial a number based on your current location. Dial: US: +1 929 205 6099 or +1 669 900 6833 or +1 720 928 9299 or 877 853 5257 (Toll Free) or 888 475 4499 (Toll Free) or 833 548 0276 (Toll Free) or 833 548 0282 (Toll Free) India: +91 806 480 2722 or +91 80 71 279 440 or +91 116 480 2722 or +91 22 48 798 004 or +91 224 879 8012 or +91 225 097 2744 or +91 225 097 2745 or +91 226 480 2722 or +91 22 71 279 525 or +91 406 480 2722 or +91 446 480 2722 or 000 800 001 4002 (Toll Free) or 000 800 050 5050 (Toll Free) Ireland: +353 6 163 9031 or +353 1 536 9320 or +353 1 653 3895 or 1800 949 238 (Toll Free) or 1800 901 561 (Toll Free) or 1800 943 965 (Toll Free) Singapore: +65 3158 7288 or +65 3165 1065 or 800 852 6054 (Toll Free) or 1800 407 5602 (Toll Free) or 800 101 3814 (Toll Free) Meeting ID: 998 7385 7206 Passcode: 9703966912 International numbers<https://xilinx.zoom.us/u/aA6qFxt9M> Join from a Video Conference room system Meeting ID: 998 7385 7206 Passcode: 9703966912 US: 99873857206(a)global.zoomcrc.com<mailto:99873857206@global.zoomcrc.com> Passcode: 9703966912 APAC: 99873857206(a)global.zoomcrc.com<mailto:99873857206@global.zoomcrc.com> Passcode: 9703966912 India: 99873857206(a)global.zoomcrc.com<mailto:99873857206@global.zoomcrc.com> Passcode: 9703966912 Europe: 99873857206(a)global.zoomcrc.com<mailto:99873857206@global.zoomcrc.com> Passcode: 9703966912 SIP: 99873857206(a)zoomcrc.com<mailto:99873857206@zoomcrc.com> Passcode: 9703966912

2 years, 5 months

1
0
0 0

Calling for agenda: 2023-02-22 OpenAMP System Reference

by Chan King Choy, Nathalie

Hi all, Sorry for the delay - catching up after the long weekend... Please let us know your requests for topics. Here is what I collected so far: * What does everyone want to get done in the next quarter? * Can refer to Dec webinar future work slides<https://docs.google.com/presentation/d/1QE0zyCxm54KoTDuWKS0Xh-mml3SneQjecDg…> to seed your thinking. Thanks & regards, Nathalie

2 years, 5 months

1
0
0 0

2023-02-08 OpenAMP System Reference notes and action items

by Chan King Choy, Nathalie

Hi all, Notes from today: https://github.com/OpenAMP/openamp-system-reference/wiki/OpenAMP-System-Ref… Action items: * Everyone: For next call: What does everyone want to get done in the next quarter? Can refer to [https://docs.google.com/presentation/d/1QE0zyCxm54KoTDuWKS0Xh-mml3SneQjecDg… Dec webinar future work slides] to seed your thinking. * Bill will start a BOF proposal slide deck w/ title & exec summary and send out for review later this week * Bill will send an email to the board list asking for any objections for the expenditure for Docker, readthedocs, and GitHub upgrade * Nathalie: Invite Stefano to TSC give an update on System DT, Bruce as back-up * Tanmay: Create pull request RFC for Zephyr IPM driver for ZynqMP with overlay for default UART change Thanks & regards, Nathalie

2 years, 6 months

1
0
0 0

Calling for agenda: 2023-02-08 OpenAMP System Reference bi-weekly

by Chan King Choy, Nathalie

Hi all, Please let us know what topics you'd like to discuss this week. Here's what I have so far: * Linaro Connect CFP is March 1, so we should sketch BOF / demo proposal outline this call & finalize in our next call Thanks & regards, Nathalie -----Original Appointment----- From: Chan King Choy, Nathalie Sent: Wednesday, January 18, 2023 10:05 AM To: Chan King Choy, Nathalie; OpenAMP System Reference; Ashfield, Bruce Cc: nathalie-ckc(a)kestrel-omnitech.com; Shah, Tanmay; Milea, Danut Gabriel (Danut); Arnaud POULIQUEN; bill.mills(a)linaro.org; Nishanth Menon; hnagalla(a)ti.com; Leino, Tammy (PLM) Subject: OpenAMP System Reference bi-weekly When: Wednesday, February 8, 2023 9:00 AM-10:00 AM (UTC-08:00) Pacific Time (US & Canada). Where: https://xilinx.zoom.us/j/99873857206?pwd=RHBvSDgxWUgrMTc2cGpleTZlTTdsdz09&f… Meeting notes can be found at https://github.com/OpenAMP/openamp-system-reference/wiki/OpenAMP-System-Ref… [Image removed by sender.]<https://zoom.us/> Hi there, Nathalie Chan King Choy is inviting you to a scheduled Zoom meeting. Join Zoom Meeting<https://xilinx.zoom.us/j/99873857206?pwd=RHBvSDgxWUgrMTc2cGpleTZlTTdsdz09&f…> Phone one-tap: US: +19292056099,,99873857206#,,,,,,0#,,9703966912#<tel:+19292056099,,99873857206#,,,,,,0#,,9703966912#> or +16699006833,,99873857206#,,,,,,0#,,9703966912#<tel:+16699006833,,99873857206#,,,,,,0#,,9703966912#> Meeting URL: https://xilinx.zoom.us/j/99873857206?pwd=RHBvSDgxWUgrMTc2cGpleTZlTTdsdz09&f… Meeting ID: 998 7385 7206 Passcode: 9hL+e9TMj8 Join by Telephone For higher quality, dial a number based on your current location. Dial: US: +1 929 205 6099 or +1 669 900 6833 or +1 720 928 9299 or 877 853 5257 (Toll Free) or 888 475 4499 (Toll Free) or 833 548 0276 (Toll Free) or 833 548 0282 (Toll Free) India: +91 806 480 2722 or +91 80 71 279 440 or +91 116 480 2722 or +91 22 48 798 004 or +91 224 879 8012 or +91 225 097 2744 or +91 225 097 2745 or +91 226 480 2722 or +91 22 71 279 525 or +91 406 480 2722 or +91 446 480 2722 or 000 800 001 4002 (Toll Free) or 000 800 050 5050 (Toll Free) Ireland: +353 6 163 9031 or +353 1 536 9320 or +353 1 653 3895 or 1800 949 238 (Toll Free) or 1800 901 561 (Toll Free) or 1800 943 965 (Toll Free) Singapore: +65 3158 7288 or +65 3165 1065 or 800 852 6054 (Toll Free) or 1800 407 5602 (Toll Free) or 800 101 3814 (Toll Free) Meeting ID: 998 7385 7206 Passcode: 9703966912 International numbers<https://xilinx.zoom.us/u/aA6qFxt9M> Join from a Video Conference room system Meeting ID: 998 7385 7206 Passcode: 9703966912 US: 99873857206(a)global.zoomcrc.com<mailto:99873857206@global.zoomcrc.com> Passcode: 9703966912 APAC: 99873857206(a)global.zoomcrc.com<mailto:99873857206@global.zoomcrc.com> Passcode: 9703966912 India: 99873857206(a)global.zoomcrc.com<mailto:99873857206@global.zoomcrc.com> Passcode: 9703966912 Europe: 99873857206(a)global.zoomcrc.com<mailto:99873857206@global.zoomcrc.com> Passcode: 9703966912 SIP: 99873857206(a)zoomcrc.com<mailto:99873857206@zoomcrc.com> Passcode: 9703966912

2 years, 6 months

2
1
0 0

RFC: zynqmp mailbox driver in zephyr

by Shah, Tanmay

Hi all, I am planning to make this example work for zynqmp board: https://github.com/OpenAMP/openamp-system-reference/tree/main/examples/zeph… I see that ST has mailbox driver (ipm) for zephyr and is used for communication with host. I found that there is no mailbox driver available for zynqmp platform. Dan’s virtio examples are using Xilinx IPI, however it is in sample directory: https://github.com/OpenAMP/zephyr-openamp-staging/blob/virtio-exp/samples/v… I feel that there is need for zynqmp mailbox driver that is using zynqmp IPI hardware for mailbox communication. Any suggestions on what will be accepted in upstream zephyr repository? Are we planning to merge virtio examples in upstream zephyr? If Dan’s approach is accepted upstream, I can use same file for rpmsg_multi_services. If not, I can take the same file and convert it into mailbox driver, then virtio example can use that driver. I am not very familiar with processes of zephyr community so any suggestion regarding that will be helpful. Thanks, Tanmay

2 years, 6 months

3
3
0 0

2023-01-25 OpenAMP System Reference notes

by Chan King Choy, Nathalie

Hi all, Notes from yesterday's call are posted at https://github.com/OpenAMP/openamp-system-reference/wiki/OpenAMP-System-Ref… * Action items: * Hari will check with Praneeth if could get travel budget * Bill will ask Linaro Events if the static link will generate stats or if we only track users landing on the resource page * Bill will ask Linaro Events if they will allow us to post the video on OpenAMP YouTube channel so that we can add a TOC * Nathalie to check the membership contract to see if assignees are required to attend Linaro Connect. * Nathalie to increase text that is hyperlinked to make it easier to see & explain how to download the slides from the resource page Thanks & regards, Nathalie

2 years, 6 months

1
0
0 0

2025

2024

2023

2022

2021

Openamp-system-reference