u-boot-brain/arch/sandbox/include/asm/gpio.h
Tom Rini 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style
When U-Boot started using SPDX tags we were among the early adopters and
there weren't a lot of other examples to borrow from.  So we picked the
area of the file that usually had a full license text and replaced it
with an appropriate SPDX-License-Identifier: entry.  Since then, the
Linux Kernel has adopted SPDX tags and they place it as the very first
line in a file (except where shebangs are used, then it's second line)
and with slightly different comment styles than us.

In part due to community overlap, in part due to better tag visibility
and in part for other minor reasons, switch over to that style.

This commit changes all instances where we have a single declared
license in the tag as both the before and after are identical in tag
contents.  There's also a few places where I found we did not have a tag
and have introduced one.

Signed-off-by: Tom Rini <trini@konsulko.com>
2018-05-07 09:34:12 -04:00

86 lines
2.5 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* This is the interface to the sandbox GPIO driver for test code which
* wants to change the GPIO values reported to U-Boot.
*
* Copyright (c) 2011 The Chromium OS Authors.
*/
#ifndef __ASM_SANDBOX_GPIO_H
#define __ASM_SANDBOX_GPIO_H
/*
* We use the generic interface, and add a back-channel.
*
* The back-channel functions are declared in this file. They should not be used
* except in test code.
*
* Test code can, for example, call sandbox_gpio_set_value() to set the value of
* a simulated GPIO. From then on, normal code in U-Boot will see this new
* value when it calls gpio_get_value().
*
* NOTE: DO NOT use the functions in this file except in test code!
*/
#include <asm-generic/gpio.h>
/**
* Return the simulated value of a GPIO (used only in sandbox test code)
*
* @param dev device to use
* @param offset GPIO offset within bank
* @return -1 on error, 0 if GPIO is low, >0 if high
*/
int sandbox_gpio_get_value(struct udevice *dev, unsigned int offset);
/**
* Set the simulated value of a GPIO (used only in sandbox test code)
*
* @param dev device to use
* @param offset GPIO offset within bank
* @param value value to set (0 for low, non-zero for high)
* @return -1 on error, 0 if ok
*/
int sandbox_gpio_set_value(struct udevice *dev, unsigned int offset, int value);
/**
* Set or reset the simulated open drain mode of a GPIO (used only in sandbox
* test code)
*
* @param gp GPIO number
* @param value value to set (0 for enabled open drain mode, non-zero for
* disabled)
* @return -1 on error, 0 if ok
*/
int sandbox_gpio_set_open_drain(struct udevice *dev, unsigned offset, int value);
/**
* Return the state of the simulated open drain mode of a GPIO (used only in
* sandbox test code)
*
* @param gp GPIO number
* @return -1 on error, 0 if GPIO is input, >0 if output
*/
int sandbox_gpio_get_open_drain(struct udevice *dev, unsigned offset);
/**
* Return the simulated direction of a GPIO (used only in sandbox test code)
*
* @param dev device to use
* @param offset GPIO offset within bank
* @return -1 on error, 0 if GPIO is input, >0 if output
*/
int sandbox_gpio_get_direction(struct udevice *dev, unsigned int offset);
/**
* Set the simulated direction of a GPIO (used only in sandbox test code)
*
* @param dev device to use
* @param offset GPIO offset within bank
* @param output 0 to set as input, 1 to set as output
* @return -1 on error, 0 if ok
*/
int sandbox_gpio_set_direction(struct udevice *dev, unsigned int offset,
int output);
#endif