3c6e9fd56d
So that the navigation pane works correctly in browsers. Some additional doc fixes put in where found (but many more still to go). Added some dummy .c and .h files to bring the associated docs into line. makefile changed to allow 'make html' as well as 'make doc' (the latter only does html anyway).
94 lines
2.8 KiB
C
94 lines
2.8 KiB
C
/** @addtogroup gpio_defines
|
|
*
|
|
* @author @htmlonly © @endhtmlonly 2011
|
|
* Fergus Noble <fergusnoble@gmail.com>
|
|
* @author @htmlonly © @endhtmlonly 2012
|
|
* Ken Sarkies <ksarkies@internode.on.net>
|
|
*
|
|
*/
|
|
/*
|
|
* This file is part of the libopencm3 project.
|
|
*
|
|
* Copyright (C) 2011 Fergus Noble <fergusnoble@gmail.com>
|
|
* Copyright (C) 2012 Ken Sarkies <ksarkies@internode.on.net>
|
|
*
|
|
* This library is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA GPIO.H
|
|
The order of header inclusion is important. gpio.h includes the device
|
|
specific memorymap.h header before including this header file.*/
|
|
|
|
/** @cond */
|
|
#if defined(LIBOPENCM3_GPIO_H)
|
|
/** @endcond */
|
|
#ifndef LIBOPENCM3_GPIO_COMMON_ALL_H
|
|
#define LIBOPENCM3_GPIO_COMMON_ALL_H
|
|
|
|
/**@{*/
|
|
|
|
#include <libopencm3/cm3/common.h>
|
|
|
|
/* --- Convenience macros -------------------------------------------------- */
|
|
|
|
/* --- GPIO_LCKR values ---------------------------------------------------- */
|
|
|
|
#define GPIO_LCKK (1 << 16)
|
|
/* GPIO_LCKR[15:0]: LCKy: Port x lock bit y (y = 0..15) */
|
|
|
|
/* GPIO number definitions (for convenience) */
|
|
/** @defgroup gpio_pin_id GPIO Pin Identifiers
|
|
@ingroup gpio_defines
|
|
|
|
@{*/
|
|
#define GPIO0 (1 << 0)
|
|
#define GPIO1 (1 << 1)
|
|
#define GPIO2 (1 << 2)
|
|
#define GPIO3 (1 << 3)
|
|
#define GPIO4 (1 << 4)
|
|
#define GPIO5 (1 << 5)
|
|
#define GPIO6 (1 << 6)
|
|
#define GPIO7 (1 << 7)
|
|
#define GPIO8 (1 << 8)
|
|
#define GPIO9 (1 << 9)
|
|
#define GPIO10 (1 << 10)
|
|
#define GPIO11 (1 << 11)
|
|
#define GPIO12 (1 << 12)
|
|
#define GPIO13 (1 << 13)
|
|
#define GPIO14 (1 << 14)
|
|
#define GPIO15 (1 << 15)
|
|
#define GPIO_ALL 0xffff
|
|
/**@}*/
|
|
|
|
BEGIN_DECLS
|
|
|
|
void gpio_set(uint32_t gpioport, uint16_t gpios);
|
|
void gpio_clear(uint32_t gpioport, uint16_t gpios);
|
|
uint16_t gpio_get(uint32_t gpioport, uint16_t gpios);
|
|
void gpio_toggle(uint32_t gpioport, uint16_t gpios);
|
|
uint16_t gpio_port_read(uint32_t gpioport);
|
|
void gpio_port_write(uint32_t gpioport, uint16_t data);
|
|
void gpio_port_config_lock(uint32_t gpioport, uint16_t gpios);
|
|
|
|
END_DECLS
|
|
|
|
/**@}*/
|
|
#endif
|
|
/** @cond */
|
|
#else
|
|
#warning "gpio_common_all.h should not be included explicitly, only via gpio.h"
|
|
#endif
|
|
/** @endcond */
|
|
|