Pin_api

Functions
void	PinModeSet (unsigned long ulPin, unsigned long ulPinMode)
unsigned long	PinModeGet (unsigned long ulPin)
void	PinDirModeSet (unsigned long ulPin, unsigned long ulPinIO)
unsigned long	PinDirModeGet (unsigned long ulPin)
void	PinConfigGet (unsigned long ulPin, unsigned long *pulPinStrength, unsigned long *pulPinType)
void	PinConfigSet (unsigned long ulPin, unsigned long ulPinStrength, unsigned long ulPinType)
void	PinTypeUART (unsigned long ulPin, unsigned long ulPinMode)
void	PinTypeI2C (unsigned long ulPin, unsigned long ulPinMode)
void	PinTypeSPI (unsigned long ulPin, unsigned long ulPinMode)
void	PinTypeI2S (unsigned long ulPin, unsigned long ulPinMode)
void	PinTypeTimer (unsigned long ulPin, unsigned long ulPinMode)
void	PinTypeCamera (unsigned long ulPin, unsigned long ulPinMode)
void	PinTypeGPIO (unsigned long ulPin, unsigned long ulPinMode, tBoolean bOpenDrain)
void	PinTypeADC (unsigned long ulPin, unsigned long ulPinMode)
void	PinTypeSDHost (unsigned long ulPin, unsigned long ulPinMode)

Detailed Description

Function Documentation

void PinConfigGet	(	unsigned long	ulPin,
		unsigned long *	pulPinStrength,
		unsigned long *	pulPinType
	)

Gets Pin output drive strength and Type

Parameters

ulPin	is one of the valid pin
pulPinStrength	is pointer to storage for output drive strength
pulPinType	is pinter to storage for pin type

This function gets the pin type and output drive strength for the pin specified by ulPin parameter. Parameters pulPinStrength and pulPinType corresponds to the values used in PinConfigSet().

Returns

None.

void PinConfigSet	(	unsigned long	ulPin,
		unsigned long	ulPinStrength,
		unsigned long	ulPinType
	)

Configure Pin output drive strength and Type

Parameters

ulPin	is one of the valid pin
ulPinStrength	is logical OR of valid output drive strengths.
ulPinType	is one of the valid pin type.

This function sets the pin type and strength for the pin specified by ulPin parameter.

The parameter ulPinStrength should be one of the following

• PIN_STRENGTH_2MA
• PIN_STRENGTH_4MA
• PIN_STRENGTH_6MA

The parameter ulPinType should be one of the following For standard type

• PIN_TYPE_STD
• PIN_TYPE_STD_PU
• PIN_TYPE_STD_PD

And for Open drain type

• PIN_TYPE_OD
• PIN_TYPE_OD_PU
• PIN_TYPE_OD_PD

Returns

None.

unsigned long PinDirModeGet

(

unsigned long

ulPin

)

Gets the direction of a pin.

Parameters

ulPin

is one of the valid pin.

This function gets the direction and control mode for a specified pin on the selected GPIO port. The pin can be configured as either an input only or output only, or it can be under hardware control. The type of control and direction are returned as an enumerated data type.

Returns

Returns one of the enumerated data types described for GPIODirModeSet().

void PinDirModeSet	(	unsigned long	ulPin,
		unsigned long	ulPinIO
	)

Sets the direction of the specified pin(s).

Parameters

ulPin	is one of the valid pin.
ulPinIO	is the pin direction and/or mode.

This function configures the specified pin(s) as either input only or output only or it configures the pin to be under hardware control.

The parameter ulPinIO is an enumerated data type that can be one of the following values:

• PIN_DIR_MODE_IN
• PIN_DIR_MODE_OUT
• PIN_DIR_MODE_HW

where PIN_DIR_MODE_IN specifies that the pin is programmed as a input only, PIN_DIR_MODE_OUT specifies that the pin is programmed output only, and PIN_DIR_MODE_HW specifies that the pin is placed under hardware control.

Returns

None.

unsigned long PinModeGet

(

unsigned long

ulPin

)

Gets current pin mux configuration of specified pin.

Parameters

ulPin

is a valid pin.

This function get the current configuration of the pin mux.

Returns

Returns current pin mode if ulPin is valid, 0xFF otherwise.

void PinModeSet	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Configures pin mux for the specified pin.

Parameters

ulPin	is a valid pin.
ulPinMode	is one of the valid mode

This function configures the pin mux that selects the peripheral function associated with a particular SOC pin. Only one peripheral function at a time can be associated with a pin, and each peripheral function should only be associated with a single pin at a time.

Returns

none

void PinTypeADC	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Sets the pin mode and configures the pin for use by ADC

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.

The ADC pins must be properly configured for the peripheral to function correctly. This function provides a typical configuration for those pin.

Note

This function cannot be used to turn any pin into a ADC pin; it only sets the pin mode and configures it for proper ADC operation.

Returns

None.

void PinTypeCamera	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Sets the pin mode and configures the pin for use by Camera peripheral

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.

The Camera pins must be properly configured for the peripheral to function correctly. This function provides a typical configuration for those pin.

Note

This function cannot be used to turn any pin into a Camera pin; it only sets the pin mode and configures it for proper Camera operation.

Returns

None.

void PinTypeGPIO	(	unsigned long	ulPin,
		unsigned long	ulPinMode,
		tBoolean	bOpenDrain
	)

Sets the pin mode and configures the pin for use by GPIO peripheral

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.
bOpenDrain	is one to decide either OpenDrain or STD

The GPIO pins must be properly configured for the peripheral to function correctly. This function provides a typical configuration for those pin.

Returns

None.

void PinTypeI2C	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Sets the pin mode and configures the pin for use by I2C peripheral

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.

The I2C pins must be properly configured for the peripheral to function correctly. This function provides a typical configuration for the pin.

Note

This function cannot be used to turn any pin into a I2C pin; it only sets the pin mode and configures it for proper I2C operation.

Returns

None.

void PinTypeI2S	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Sets the pin mode and configures the pin for use by I2S peripheral

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.

The I2S pins must be properly configured for the peripheral to function correctly. This function provides a typical configuration for those pin.

Note

This function cannot be used to turn any pin into a I2S pin; it only sets the pin mode and configures it for proper I2S operation.

Returns

None.

void PinTypeSDHost	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Sets the pin mode and configures the pin for use by SD Host peripheral

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.

The MMC pins must be properly configured for the peripheral to function correctly. This function provides a typical configuration for those pin.

Note

This function cannot be used to turn any pin into a SD Host pin; it only sets the pin mode and configures it for proper SD Host operation.

Returns

None.

void PinTypeSPI	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Sets the pin mode and configures the pin for use by SPI peripheral

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.

The SPI pins must be properly configured for the peripheral to function correctly. This function provides a typical configuration for those pin.

Note

This function cannot be used to turn any pin into a SPI pin; it only sets the pin mode and configures it for proper SPI operation.

Returns

None.

void PinTypeTimer	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Sets the pin mode and configures the pin for use by Timer peripheral

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.

The timer PWM pins must be properly configured for the Timer peripheral to function correctly. This function provides a typical configuration for those pin; other configurations may work as well depending upon the board setup (for example, using the on-chip pull-ups).

Note

This function cannot be used to turn any pin into a timer PWM pin; it only sets the pin mode and configures it for proper timer PWM operation.

Returns

None.

void PinTypeUART	(	unsigned long	ulPin,
		unsigned long	ulPinMode
	)

Sets the pin mode and configures the pin for use by UART peripheral

Parameters

ulPin	is one of the valid pin.
ulPinMode	is one of the valid pin mode.

The UART pins must be properly configured for the peripheral to function correctly. This function provides a typical configuration for those pin(s); other configurations may work as well depending upon the board setup (for example, using the on-chip pull-ups).

Note

This function cannot be used to turn any pin into a UART pin; it only sets the pin mode and configures it for proper UART operation.

Returns

None.