Unit PCF857X - Revision history

Ultibo at 05:45, 31 August 2021

2021-08-31T05:45:44Z

Ultibo at 06:25, 21 July 2021

2021-07-21T06:25:13Z

Ultibo at 06:01, 19 June 2021

2021-06-19T06:01:05Z

Ultibo at 05:17, 19 June 2021

2021-06-19T05:17:26Z

Ultibo at 03:20, 19 June 2021

2021-06-19T03:20:48Z

Ultibo at 03:18, 19 June 2021

2021-06-19T03:18:51Z

Ultibo at 03:41, 18 June 2021

2021-06-18T03:41:08Z

Ultibo: Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To..."

2021-06-18T03:10:10Z

Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To..."

New page

Return to [[Unit_Reference|Unit Reference]]

=== Description ===
----

''To be documented''

=== Constants ===
----

''To be documented''

=== Type definitions ===
----

''To be documented''

=== Public variables ===
----

''To be documented''

=== Function declarations ===
----

''To be documented''

Return to [[Unit_Reference|Unit Reference]]

@@ Line 5: / Line 5: @@
 ----
-'''NXP PCF857X I/O expander Driver'''
+'''NXP PCF857X I/O Expander Driver unit'''
 The NXP PCF8574 is an 8 bit I/O expander that provides GPIO pin control functions over an I2C connection.

← Older revision		Revision as of 06:01, 19 June 2021
Line 105:		Line 105:
	----		----

−	~~''To be documented''~~

		+	'''PCF857X functions'''
		+
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF8574GPIOCreate(I2C:PI2CDevice; Address:Word):PGPIODevice;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create, register and start a new PCF8574 GPIO device connected to the specified I2C device</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! I2C
		+	\| The I2C device this PCF8574 is connected to
		+	\|-
		+	! Address
		+	\| The I2C address for this PCF8574
		+	\|-
		+	! Return
		+	\| Pointer to the new GPIO device or nil on failure
		+
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIODestroy(GPIO:PGPIODevice):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stop, deregister and destroy a PCF857X GPIO device created by this driver</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! GPIO
		+	\| The GPIO device to destroy
		+	\|-
		+	! Return
		+	\| ERROR_SUCCESS if completed or another error code on failure
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+
		+	'''PCF857X GPIO functions'''
		+
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIOStart(GPIO:PGPIODevice):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceStart API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODeviceStart instead.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIOStop(GPIO:PGPIODevice):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceStop API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODeviceStop instead.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIORead(GPIO:PGPIODevice; Reg:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceRead API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODeviceRead instead.
		+	Will read only a single register byte.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">procedure PCF857XGPIOWrite(GPIO:PGPIODevice; Reg,Value:LongWord);</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceWrite API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODeviceWrite instead.
		+	Will write only a single register byte.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIOInputGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceInputGet API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODeviceInputGet instead.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIOOutputSet(GPIO:PGPIODevice; Pin,Level:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceOutputSet API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODeviceOutputSet instead.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIOPullGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODevicePullGet API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODevicePullGet instead.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIOFunctionGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceFunctionGet API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODeviceFunctionGet instead.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function PCF857XGPIOFunctionSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceFunctionSelect API for PCF857X</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Not intended to be called directly by applications, use GPIODeviceFunctionSelect instead.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />

	Return to [[Unit_Reference\|Unit Reference]]		Return to [[Unit_Reference\|Unit Reference]]

@@ Line 9: / Line 9: @@
 The NXP PCF8574 is an 8 bit I/O expander that provides GPIO pin control functions over an I2C connection.
-The device can be represented in Ultibo as a standard GPIO device which is accessable via the GPIO unit functions. Because the PCF857X is a chip that can be used and configured in multiple different scenarios this unit does not autocreate a GPIO device, instead you need to call the function PCF8574GPIOCreate and pass an I2C device and address. The function will create and return a GPIO device with the appropriate number of pins and other information for the specified chip, the returned devices will have been registered with the GPIO device unit and started ready for use.
+The device can be represented in Ultibo as a standard GPIO device which is accessible via the GPIO unit functions. Because the PCF857X is a chip that can be used and configured in multiple different scenarios this unit does not autocreate a GPIO device, instead you need to call the function PCF8574GPIOCreate and pass an I2C device and address. The function will create and return a GPIO device with the appropriate number of pins and other information for the specified chip, the returned devices will have been registered with the GPIO device unit and started ready for use.
 Note: This unit does not currently implement the interrupt capabilities of the PCF857X chips however it could be expanded to allow the interrupt pin to be connected to a GPIO pin on the SoC and use a trigger event from that to enable GPIOInputWait/GPIOInputEvent functions for the PCF857X chips.
@@ Line 26: / Line 26: @@
 ----
-''To be documented''
+''None defined''
 === Function declarations ===

← Older revision		Revision as of 03:18, 19 June 2021
Line 6:		Line 6:

	'''NXP PCF857X I/O expander Driver'''		'''NXP PCF857X I/O expander Driver'''
		+
		+	The NXP PCF8574 is an 8 bit I/O expander that provides GPIO pin control functions over an I2C connection.
		+
		+	The device can be represented in Ultibo as a standard GPIO device which is accessable via the GPIO unit functions. Because the PCF857X is a chip that can be used and configured in multiple different scenarios this unit does not autocreate a GPIO device, instead you need to call the function PCF8574GPIOCreate and pass an I2C device and address. The function will create and return a GPIO device with the appropriate number of pins and other information for the specified chip, the returned devices will have been registered with the GPIO device unit and started ready for use.
		+
		+	Note: This unit does not currently implement the interrupt capabilities of the PCF857X chips however it could be expanded to allow the interrupt pin to be connected to a GPIO pin on the SoC and use a trigger event from that to enable GPIOInputWait/GPIOInputEvent functions for the PCF857X chips.

	=== Constants ===		=== Constants ===

@@ Line 95: / Line 95: @@
 ----
-''To be documented''
 === Public variables ===

@@ Line 16: / Line 16: @@
 ----
-''To be documented''
 === Type definitions ===