feat(linux): Add eCAP documentation#733
Open
jmenti wants to merge 1 commit into
Open
Conversation
jmenti
requested review from
StaticRocket,
VeeruPrudhvi,
cshilwant,
gehariprasath,
jeevantelukula,
praneethbajjuri and
uditkumarti
as code owners
github-actions
Bot
assigned
devarsht,
gehariprasath,
praneethbajjuri,
r-vignesh and
uditkumarti
Add eCAP documentation and enable for devices currently enabling eCAP via overlays in TI Linux Kernel. Signed-off-by: Judith Mendez <jm@ti.com>
StaticRocket
requested changes
Jul 9, 2026
Comment on lines
+5
to
+6
| Introduction | ||
| ============ |
Member
There was a problem hiding this comment.
| Auxillary | ||
| BeagleBone | ||
| Broadcom | ||
| eCAP |
Member
There was a problem hiding this comment.
This is an acronym, not a real word.
| @@ -1,15 +1,19 @@ | |||
| Armbian | |||
| Auxillary | |||
Member
There was a problem hiding this comment.
This is a misspelling of auxiliary and is not used in this pr oddly enough.
| Debian | ||
| GStreamer | ||
| Jacinto | ||
| Kernel |
Member
There was a problem hiding this comment.
The term Kernel should normally be lowercase. It's not a proper name.
| OpenCL | ||
| OpenGL | ||
| OpenVX | ||
| pinctrl |
Member
There was a problem hiding this comment.
This also isn't a real word. It's just shorthand for pin control.
Comment on lines
+309
to
+310
| from module clock according to clock signal action. Every rising edge of clock | ||
| increments counter +1. |
Member
There was a problem hiding this comment.
Suggested change
| from module clock according to clock signal action. Every rising edge of clock | |
| increments counter +1. | |
| from module clock according to clock signal action. Every rising edge increments the counter by one. |
| 2 | ||
|
|
||
| Attribute :file:`num_overflows` increments when counter wraps around | ||
| (0xFFFFFFFF → 0x00000000). |
|
|
||
| **Verify PWM functionality:** | ||
|
|
||
| See troubleshooting in :doc:`PWM` guide and monitor eCAP PWM through :file:`/sys/kernel/debug/pwm`. |
Member
There was a problem hiding this comment.
Please avoid using the doc role. It's not as reliable as the usual ref cross-referencing mechanism.
|
|
||
| $ cat /sys/bus/counter/devices/counterX/name | ||
|
|
||
| If not present, verify the overlay applied and check for pin conflicts in dmesg log. |
Member
There was a problem hiding this comment.
Suggested change
| If not present, verify the overlay applied and check for pin conflicts in dmesg log. | |
| If not present, verify the overlay applied and check for pin conflicts reported in the ``dmesg`` log. |
Comment on lines
+372
to
+373
| Interrupt count increments on each capture event or overflow. High counts on | ||
| active signal indicate interrupts working correctly. |
Member
There was a problem hiding this comment.
Suggested change
| Interrupt count increments on each capture event or overflow. High counts on | |
| active signal indicate interrupts working correctly. | |
| The interrupt count will increment on each capture event or overflow. A high count on | |
| the active signal indicates the interrupts are working correctly. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add eCAP documentation and enable for devices currently enabling eCAP via overlays in TI Linux Kernel.