View source for Template:SYSFS GPIO MANIPULATION

<!-- Start to phase out sysfs by hiding it for imx9 and future SOC_FAMILY. Eventually, drop this for all families 
-->{{#switch:{{#var:SOC_FAMILY}}
|imx8m=
= Manipulating a single GPIO via /sys/class/gpio =
<section begin=gpio_sysfs_warning_section/> <!--
-->{{Note|Note: The /sys/class/gpio ABI is being deprecated in the Linux kernel and is being replaced by the GPIO character device and [{{#var:LIBGPIOD_URL}} libgpiod]. Please refer to the kernel [https://github.com/varigit/linux-imx/blob/{{#var:KERNEL_BRANCH}}/Documentation/ABI/obsolete/sysfs-gpio Documentation] for the latest information.|error}}<!--
--><section end=gpio_sysfs_warning_section/>
== Using a command line or a script ==
GPIOs in i.MX are grouped in groups of 32 pins.<br>
For example, GPIO1_3 belong to the first group, pin 3. Its absolute number will be 3.<br>
GPIO4_21 will be (4-1)*32+21=117.<br>
Assuming this GPIO is defined in your device tree, the following is an example of how to use it from userspace.<br>
<br>
To export the GPIO for userspace use:
<pre>
$ echo 117 > /sys/class/gpio/export
</pre>
<br>
To configure as output:
<pre>
$ echo out > /sys/class/gpio/gpio117/direction
</pre>
Set GPIO high:
<pre>
$ echo 1 > /sys/class/gpio/gpio117/value
</pre>
Set GPIO low:
<pre>
$ echo 0 > /sys/class/gpio/gpio117/value
</pre>
<br>
To configure as input:
<pre>
$ echo in > /sys/class/gpio/gpio117/direction
</pre>
Read the current value:
<pre>
$ cat /sys/class/gpio/gpio117/value
</pre>
<br>
To free the GPIO after you're done using it:
<pre>
$ echo 117 > /sys/class/gpio/unexport
</pre>

== Using a C application ==
All of the command line operations above can be translated to C code:<br>
Reserve (export) the GPIO:<br>
<pre>
#define IMX_GPIO_NR(port, index)    ((((port)-1)*32)+((index)&31))

int fd;
char buf[MAX_BUF]; 
int gpio = IMX_GPIO_NR(4, 21); /* Just an example */

fd = open("/sys/class/gpio/export", O_WRONLY);

sprintf(buf, "%d", gpio); 

write(fd, buf, strlen(buf));

close(fd);
</pre>
Set the GPIO direction:<br>
<pre>
sprintf(buf, "/sys/class/gpio/gpio%d/direction", gpio);

fd = open(buf, O_WRONLY);

/* Set out direction */
write(fd, "out", 3); 
/* Set in direction */
write(fd, "in", 2); 

close(fd);
</pre>

In case of out direction set the GPIO value:
<pre>
sprintf(buf, "/sys/class/gpio/gpio%d/value", gpio);

fd = open(buf, O_WRONLY);

/* Set GPIO high status */
write(fd, "1", 1); 
/* Set GPIO low status */
write(fd, "0", 1); 

close(fd);
</pre>

In case of in direction get the current GPIO value:
<pre>
char value;

sprintf(buf, "/sys/class/gpio/gpio%d/value", gpio);

fd = open(buf, O_RDONLY);

read(fd, &value, 1);

if (value == '0') { 
     /* Current GPIO status low */
} else {
     /* Current GPIO status high */
}

close(fd);
</pre>

Once finished, free (unexport) the GPIO:
<pre>
fd = open("/sys/class/gpio/unexport", O_WRONLY);

sprintf(buf, "%d", gpio);

write(fd, buf, strlen(buf));

close(fd);
</pre>

Important notes:<br>
* Remember that after the first read operation the file pointer will move to the next position in the file, so to get a correct value for each read operation you simply have to set the file pointer at the beginning of the file before read by using the following command:
<pre>
lseek(fd, 0, SEEK_SET);
</pre>
* This is only a short example. If you want to use it in your code remember add error handling to it.
}}<!-- END OF SYSFS -->