gpio.h File Reference


Detailed Description

General purpose I/O.

Copyright (C) 2007 by egnite Software GmbH. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holders nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

For additional information see http://www.ethernut.de/

 * $Id: gpio.h,v 1.1 2008/01/31 09:22:32 haraldkipp Exp $
 * 

Definition in file gpio.h.

Go to the source code of this file.

Data Structures

struct  GPIO_VECTOR
struct  GPIO_SIGNAL

Defines

#define GPIO_CFG_DISABLED   0x00000001
 GPIO disabled.
#define GPIO_CFG_OUTPUT   0x00000002
 GPIO output direction enabled.
#define GPIO_CFG_PULLUP   0x00000004
 GPIO pull-up enabled.
#define GPIO_CFG_MULTIDRIVE   0x00000008
 GPIO open drain output feature enabled.
#define GPIO_CFG_DEBOUNCE   0x00000010
 GPIO input glitch filter enabled.

Functions

u_long GpioPinConfigGet (int bank, int bit)
 Get pin configuration.
int GpioPinConfigSet (int bank, int bit, u_long flags)
 Set pin configuration.
int GpioPortConfigSet (int bank, u_int mask, u_long flags)
 Set port wide pin configuration.
int GpioPinGet (int bank, int bit)
 Get pin level.
void GpioPinSet (int bank, int bit, int value)
 Set pin level.
void GpioPinSetLow (int bank, int bit)
 Set pin level to low.
void GpioPinSetHigh (int bank, int bit)
 Set pin level to high.
u_int GpioPortGet (int bank)
 Get all pin levels of a specified bank/port.
void GpioPortSet (int bank, u_int value)
 Set all pin levels of a bank/port.
void GpioPortSetLow (int bank, u_int mask)
 Set multiple pin levels of a bank/port to low.
void GpioPortSetHigh (int bank, u_int mask)
 Set multiple pin levels of a bank/port to high.
int GpioRegisterIrqHandler (GPIO_SIGNAL *sig, int bit, void(*handler)(void *), void *arg)
 Register a GPIO pin interrupt handler.
int GpioIrqEnable (GPIO_SIGNAL *sig, int bit)
 Enable a specified GPIO interrupt.
int GpioIrqDisable (GPIO_SIGNAL *sig, int bit)
 Disable a specified GPIO interrupt.


Define Documentation

#define GPIO_CFG_DISABLED   0x00000001

GPIO disabled.

Will activate the pins alternate function if set. This may not work on all platforms.

Definition at line 54 of file gpio.h.

Referenced by GpioPinConfigGet(), and GpioPortConfigSet().

#define GPIO_CFG_OUTPUT   0x00000002

GPIO output direction enabled.

If set, the pin is configured as an output. Otherwise it is in input mode or z-state.

Examples:
portdio/portdio.c.

Definition at line 62 of file gpio.h.

Referenced by GpioPinConfigGet(), GpioPinConfigSet(), GpioPortConfigSet(), and init_dio().

#define GPIO_CFG_PULLUP   0x00000004

GPIO pull-up enabled.

Examples:
portdio/portdio.c.

Definition at line 67 of file gpio.h.

Referenced by GpioPinConfigGet(), GpioPinConfigSet(), GpioPortConfigSet(), and init_dio().

#define GPIO_CFG_MULTIDRIVE   0x00000008

GPIO open drain output feature enabled.

If not set, the output will use push pull mode.

Definition at line 74 of file gpio.h.

Referenced by GpioPinConfigGet(), and GpioPortConfigSet().

#define GPIO_CFG_DEBOUNCE   0x00000010

GPIO input glitch filter enabled.

Definition at line 79 of file gpio.h.

Referenced by GpioPinConfigGet(), and GpioPortConfigSet().


Function Documentation

u_long GpioPinConfigGet ( int  bank,
int  bit 
)

Get pin configuration.

Parameters:
bank GPIO bank/port number.
bit Bit number of the specified bank/port.
Returns:
Attribute flags of the pin.

Definition at line 372 of file gpio_avr.c.

Referenced by GpioPinConfigSet().

int GpioPinConfigSet ( int  bank,
int  bit,
u_long  flags 
)

Set pin configuration.

Applications may also use this function to make sure, that a specific attribute is available for a specific pin.

Note:
GPIO pins are typically initialized to a safe state after power up. This routine is not able to determine the consequences of changing pin configurations. In the worst case you may permanently damage your hardware by bad pin settings.
Parameters:
bank GPIO bank/port number.
bit Bit number of the specified bank/port.
flags Attribute flags.
Returns:
0 if all attributes had been set, -1 otherwise.
Examples:
portdio/portdio.c.

Definition at line 700 of file gpio_avr.c.

Referenced by init_dio().

int GpioPortConfigSet ( int  bank,
u_int  mask,
u_long  flags 
)

Set port wide pin configuration.

Note:
This function does not check for undefined ports and pins or invalid attributes. If this is required, use GpioPinConfigSet().
Parameters:
bank GPIO bank/port number.
mask The given attributes are set for a specific pin, if the corresponding bit in this mask is 1.
flags Attribute flags to set.
Returns:
Always 0.

Definition at line 501 of file gpio_avr.c.

Referenced by GpioPinConfigSet().

int GpioPinGet ( int  bank,
int  bit 
)

Get pin level.

Copyright (C) 2007 by egnite Software GmbH. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holders nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

For additional information see http://www.ethernut.de/

Id

Copyright (C) 2007 by egnite Software GmbH. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holders nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

For additional information see http://www.ethernut.de/

Id

Parameters:
bank GPIO bank/port number.
bit Bit number of the specified bank/port.
Returns:
1 if the pin level is high. 0 is returned if the pin level is low or if the pin is undefined.
Examples:
portdio/portdio.c.

Definition at line 44 of file gpio_avr.c.

void GpioPinSet ( int  bank,
int  bit,
int  value 
)

Set pin level.

Trying to set undefined pins is silently ignored.

Parameters:
bank GPIO bank/port number.
bit Bit number of the specified bank/port.
value Level, 0 for low or any other value for high.

Definition at line 231 of file gpio_avr.c.

void GpioPinSetLow ( int  bank,
int  bit 
)

Set pin level to low.

Trying to set undefined pins is silently ignored.

Parameters:
bank GPIO bank/port number.
bit Bit number of the specified bank/port.
Examples:
portdio/portdio.c.

Definition at line 99 of file gpio_avr.c.

Referenced by GpioPinSet(), init_dio(), and ProcessRequests().

void GpioPinSetHigh ( int  bank,
int  bit 
)

Set pin level to high.

Trying to set undefined pins is silently ignored.

Parameters:
bank GPIO bank/port number.
bit Bit number of the specified bank/port.
Examples:
portdio/portdio.c.

Definition at line 165 of file gpio_avr.c.

Referenced by GpioPinSet(), and ProcessRequests().

u_int GpioPortGet ( int  bank  ) 

Get all pin levels of a specified bank/port.

Parameters:
bank GPIO bank/port number.
Returns:
Pin levels. 0 is returned for unknown banks and pins.

Definition at line 241 of file gpio_avr.c.

Referenced by GpioPortSetHigh(), and GpioPortSetLow().

void GpioPortSet ( int  bank,
u_int  value 
)

Set all pin levels of a bank/port.

This routine can be used to simultanously set all pins of a specific port. However, in some implementations the high bit values will be set before the low bit values. If this is a problem, you should use GpioPortSetHigh() and GpioPortSetLow().

Parameters:
bank GPIO bank/port number.
value Pin levels are set to high, if the corresponding bit in this mask is 1. All other pin levels are set to low.

Definition at line 296 of file gpio_avr.c.

Referenced by GpioPortSetHigh(), and GpioPortSetLow().

void GpioPortSetLow ( int  bank,
u_int  mask 
)

Set multiple pin levels of a bank/port to low.

Parameters:
bank GPIO bank/port number.
mask Pin levels are set to low, if the corresponding bit in this mask is 1.
Returns:
Levels.

Definition at line 362 of file gpio_avr.c.

Referenced by GpioPortSet().

void GpioPortSetHigh ( int  bank,
u_int  mask 
)

Set multiple pin levels of a bank/port to high.

Trying to set undefined ports is silently ignored.

Parameters:
bank GPIO bank/port number.
mask Pin levels are set to high, if the corresponding bit in this mask is 1.

Definition at line 367 of file gpio_avr.c.

Referenced by GpioPortSet().

int GpioRegisterIrqHandler ( GPIO_SIGNAL sig,
int  bit,
void(*)(void *)  handler,
void *  arg 
)

Register a GPIO pin interrupt handler.

Generating interrupts on GPIO pin changes is not supported on all platforms. In this case dedicated external interrupt pins may be used with NutRegisterIrqHandler().

Interrupts are triggered on rising and falling edges. Level triggering or triggering on specific edges is not supported.

After registering, interrupts are disabled. Calling GpioIrqEnable() is required to activate the interrupt.

The following code fragment registers an interrupt handler which is called on each change of bit 4 of the first GPIO port:

 #include <dev/gpio.h>

 static void PinChange(void *arg)
 {
     ...
 }

 {
     ...
     GpioPinConfigSet(0, 4, GPIO_CFG_PULLUP);
     GpioRegisterIrqHandler(&sig_GPIO, 4, PinChange, NULL);
     GpioIrqEnable(&sig_GPIO, 30);
     ...
 }

Parameters:
sig Bank/port interrupt to be associated with this handler.
bit Bit number of the specified bank/port.
handler This routine will be called by Nut/OS, when the specified pin changes its state.
arg Argument to be passed to the interrupt handler routine.
Returns:
0 on success, -1 otherwise.

Definition at line 812 of file gpio_avr.c.

int GpioIrqEnable ( GPIO_SIGNAL sig,
int  bit 
)

Enable a specified GPIO interrupt.

A related interrupt handler must have been registered before calling this function. See GpioRegisterIrqHandler().

Parameters:
sig Interrupt to enable.
bit Bit number of the specified bank/port.
Returns:
0 on success, -1 otherwise.

Definition at line 817 of file gpio_avr.c.

int GpioIrqDisable ( GPIO_SIGNAL sig,
int  bit 
)

Disable a specified GPIO interrupt.

Parameters:
sig Interrupt to disable.
bit Bit number of the specified bank/port.
Returns:
0 on success, -1 otherwise.

Definition at line 822 of file gpio_avr.c.


© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/