nuttxpr commented on PR #15861: URL: https://github.com/apache/nuttx/pull/15861#issuecomment-2667227193
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) The provided information is a good start but is missing crucial details required by the NuttX PR template. Here's a breakdown of what's missing and how to improve it: **Missing/Incomplete Information:** * **Summary:** While it mentions adding GPIO support, it lacks specifics. *Which* GPIO pins? Were any drivers changed/added? How is the GPIO configuration handled (e.g., device tree, board configuration)? What was the motivation for adding this support (was it requested, needed for a specific application, etc.)? * **Impact:** The impact section is too general. Be specific: * **Impact on user:** *How* will users use this? Are there any configuration changes required? Any new APIs? Give examples. * **Impact on build:** Does this change Kconfig options? Are new files added to the build system? * **Impact on hardware:** Specifically mention the STM32F401RC. Are there any pin conflicts? Does it affect any other hardware on the board? * **Documentation:** If documentation is needed, either provide it in the PR or create a separate issue to track documentation updates. Explicitly state if no documentation updates are needed. * **Security:** While it might seem irrelevant for GPIO, consider if there are any potential security implications. For example, if a GPIO is incorrectly configured, could it expose a vulnerability? If not, explicitly state "NO". * **Compatibility:** Does this impact any existing drivers or applications? If not, explicitly state "NO". * **Testing:** * **Build Host(s):** Provide details of your development environment. Example: `Linux, x86_64, GCC 12.2` * **Target(s):** Be explicit. Example: `STM32F401RC, sim:nsh` or `STM32F401RC, board:stm32f401rc-rs485_nsh` (use the correct config name). * **Testing logs before change:** This is crucial. Show that the GPIO functionality *didn't* work before your changes. An error message, or simply stating "GPIO functionality not available" is sufficient. * **Testing logs after change:** While the provided logs demonstrate basic functionality, they are incomplete. Test different GPIO pins, input with interrupts, and error handling. Ensure the logs are complete and easy to understand. **Example of an Improved PR Description:** ``` ## Summary This PR adds GPIO support for the STM32F401RC RS485 board, specifically enabling GPIO pins PA0-PA7. This was needed to support [application/reason - e.g., a new sensor driver or a user request]. The implementation adds a new GPIO driver instance in the board configuration file (`boards/arm/stm32/stm32f401rc-rs485/src/stm32_bringup.c`). ## Impact * **Impact on user:** YES. Users can now access and control GPIO pins PA0-PA7 through the `/dev/gpioN` device nodes (where N is the GPIO number). Example usage is provided in the Testing section. Users will need to enable `CONFIG_DEV_GPIO` and `CONFIG_EXAMPLES_GPIO` in their configuration to use the GPIO driver and example application. * **Impact on build:** YES. The build system now includes the new GPIO driver instance in the `stm32f401rc-rs485` board configuration. * **Impact on hardware:** YES. This change specifically affects the STM32F401RC RS485 board by enabling GPIO functionality on pins PA0-PA7. No pin conflicts are anticipated. * **Impact on documentation:** YES. Documentation updates have been provided in this PR to describe the new GPIO configuration and usage. (Or: NO. The changes are self-explanatory and don't require documentation updates.) * **Impact on security:** NO. * **Impact on compatibility:** NO. * **Anything else to consider:** None. ## Testing I confirm that changes are verified on local setup and works as intended: * Build Host(s): Linux, x86_64, GCC 12.2 * Target(s): STM32F401RC, board:stm32f401rc-rs485_nsh Testing logs before change: ``` nsh> gpio /dev/gpio0 gpio: /dev/gpio0: No such file or directory ``` Testing logs after change: ``` nsh> gpio -o 0 /dev/gpio0 Driver: /dev/gpio0 Output pin: Value=1 Writing: Value=0 Verify: Value=0 ... (Test other GPIO pins, input functionality, and interrupt functionality) nsh> gpio -i /dev/gpio2 (interrupt test) ... (Show interrupt triggering) ... ``` ``` ``` By providing more specific details, you'll make it much easier for reviewers to understand and approve your PR. Remember to replace the example information with the actual details of your changes. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
