This is an automated email from Gerrit. Tomasz CEDRO ([email protected]) just uploaded a new patch set to Gerrit, which you can find at http://openocd.zylin.com/1017
-- gerrit commit a2f27624118364fbe869b44dc08d07b1c4846278 Author: Tomek CEDRO <[email protected]> Date: Tue Oct 30 15:25:37 2012 +0100 Minor comments/description modification. No functional/code changes. Change-Id: I41fff9e4959a904c2606b82be99265ba9b01bf7a Signed-off-by: Tomek CEDRO <[email protected]> diff --git a/src/jtag/interface.h b/src/jtag/interface.h index 72af2fe..5e4b8af 100644 --- a/src/jtag/interface.h +++ b/src/jtag/interface.h @@ -8,6 +8,9 @@ * Copyright (C) 2009 Zachary T Welch * * [email protected] * * * + * Copyright (C) 2011-2012 Tomasz Boleslaw CEDRO * + * [email protected], http://www.tomek.cedro.info * + * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * @@ -219,6 +222,12 @@ struct jtag_interface { /** * Set the interface speed. + * @a speed is usually the internal interface clock source divisor value + * that directly impacts transport TCK/CLK frequency. If you want to + * specify clock frequency in kHz, you must first calculate it with + * @a khz() function. Using speed==-1 enables adaptive clocking based + * on RTCK signal (however not all devices support this feature). + * * @param speed The new interface speed setting. * @returns ERROR_OK on success, or an error code on failure. */ @@ -255,6 +264,12 @@ struct jtag_interface { * Returns JTAG maxium speed for KHz. 0 = RTCK. The function returns * a failure if it can't support the KHz/RTCK. * + * Calculates jtag_speed value for given transport clock frequency + * specified in kHz. @a jtag_speed is usually the internal interface clock + * source divisor value that directly impacts transport TCK/CLK frequency. + * For @a jtag_speed=0 adaptive clocking is used, based on RTCK signal. + * Function returns error code if an interface does not support kHz/RTCK. + * * WARNING!!!! if RTCK is *slow* then think carefully about * whether you actually want to support this in the driver. * Many target scripts are written to handle the absence of RTCK -- ------------------------------------------------------------------------------ LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial Remotely access PCs and mobile devices and provide instant support Improve your efficiency, and focus on delivering more value-add services Discover what IT Professionals Know. Rescue delivers http://p.sf.net/sfu/logmein_12329d2d _______________________________________________ OpenOCD-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/openocd-devel
