From 8f1018388451cb8554be2a12dc10c8dcead0d7e8 Mon Sep 17 00:00:00 2001 From: Michael Buesch Date: Sun, 21 Mar 2010 14:08:19 +0100 Subject: Update documentation Signed-off-by: Michael Buesch --- README-DEVELOPERS.lyx | 60 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 41 insertions(+), 19 deletions(-) (limited to 'README-DEVELOPERS.lyx') diff --git a/README-DEVELOPERS.lyx b/README-DEVELOPERS.lyx index 414c462..a2c62c3 100644 --- a/README-DEVELOPERS.lyx +++ b/README-DEVELOPERS.lyx @@ -504,7 +504,7 @@ Chip \end_layout \begin_layout LyX-Code -RegisteredChip(Chip_MyDevice, +RegisteredChip(Chip_MyDevice, bitfile = \begin_inset Quotes eld \end_inset @@ -512,12 +512,24 @@ bitfileID \begin_inset Quotes erd \end_inset +, chipID = +\begin_inset Quotes eld +\end_inset + +myChipID +\begin_inset Quotes erd +\end_inset + ) \end_layout \begin_layout Standard The class (_not_ an instance of it) is passed as first parameter. The ID string of the required bitfile is past as second parameter. + A chipID might also be passed. + If the chipID is omitted, the bitfileID is used as chipID. + There are more optional parameters to RegisteredChip(). + See the inline sourcecode documentation for details. \end_layout \begin_layout Subsection @@ -612,11 +624,11 @@ class Chip \begin_inset Quotes erd \end_inset -s autogenerator interface: +s autogenerator interface. \end_layout \begin_layout Standard -The constructor (__init__()) has some autogenerator related parameters. +The constructor (__init__()) has some autogenerator related parameters: \end_layout \begin_layout Description @@ -660,6 +672,8 @@ chipPinsVPP This parameter is an integer or a list of integers specifying So if your chip datasheet tells you that VCC is on pin 1, you pass an 1 here. If your chip needs multiple VPP voltages, just pass a list of pins. + Specify all possible VPP pins here. + Which pin is actually activated is decided later in applyVPP(). \end_layout \begin_layout Description @@ -693,11 +707,33 @@ applyVCCX(on) This method enables or disables (depending on the parameter) \end_layout \begin_layout Description -applyVPP(on) This method enables or disables (depending on the parameter) - a layout. +applyVPP(on,packagePinsToTurnOn) This method enables or disables (depending + on the parameter) a layout. Enabling the layout means that the VPP pins will be actively driven by the configured VPP voltage. Disabling the layout will tristate the driver. + The first parameter +\begin_inset Quotes eld +\end_inset + +on +\begin_inset Quotes erd +\end_inset + + is a boolean to turn ON or OFF the VPP layout. + The second parameter is an optional list of package-pin-numbers specifying + which VPP is turned on. + If the second parameter is not passed, all possible VPPs that were specified + in the constructor are turned on. + The second parameter is unused, if +\begin_inset Quotes eld +\end_inset + +on=False +\begin_inset Quotes erd +\end_inset + +. \end_layout \begin_layout Description @@ -708,19 +744,5 @@ applyGND(on) This method enables or disables (depending on the parameter) Disabling the layout will tristate the driver. \end_layout -\begin_layout Description -regenerateVoltageLayouts(chipPackage,chipPinVCCX,chipPinsVPP,chipPinGND) - This method lets you regenerate the voltage layouts. - That is useful, if you need to change one or more of the layouts for different - programming tasks. - For example it is common that VPP may be required on distinct pins for - different operations. - Note that it is not required to pass the auto-layout parameters to the - __init__() constructor, if you plan to use this method instead. - The parameters to this method match the parameters to the __init__() constructo -r. - See above for a detailled description of these parameters. -\end_layout - \end_body \end_document -- cgit v1.2.3