#404 src/jtag/interface.h adapter_driver::reset(int srst, int trst) args are in wrong order

[Tommy Murphy]

src/jtag/interface.h adapter_driver::reset(int srst, int trst) args are in wrong order with respect to how they appear elsewhere in the code and driver implementations.

See this mailing list thread for more info:

• https://sourceforge.net/p/openocd/mailman/openocd-user/thread/LO0P265MB6866BD80CFBB5815ED072575F923A@LO0P265MB6866.GBRP265.PROD.OUTLOOK.COM/

In practice this has no functional impact but should probably be fixed to avoid confusion?

I think that the fix is trivial - change this:

     * @param srst 1 to assert SRST, 0 to deassert SRST.
     * @param trst 1 to assert TRST, 0 to deassert TRST.
     * @returns ERROR_OK on success, or an error code on failure.
     */
    int (*reset)(int srst, int trst);

to this:

     * @param trst 1 to assert TRST, 0 to deassert TRST.
     * @param srst 1 to assert SRST, 0 to deassert SRST.
     * @returns ERROR_OK on success, or an error code on failure.
     */
    int (*reset)(int trst, int srst);

I'm not clear yet if any changes are also needed to the user or developer documentation or anywhere else?

• https://openocd.org/doc-release/html/index.html
• https://openocd.org/doc-release/doxygen/index.html

[Tommy Murphy]

Oops - link to mailing list got messed up and I can't seem to edit the original ticket post.
Let's try again...

• https://sourceforge.net/p/openocd/mailman/openocd-user/thread/CAMVnO%2B%3DzTmYdXBoi4uJ_A02w5CCQSiCA6EK0j9NhBSvKmjWJ9A%40mail.gmail.com/#msg37861236