pio.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------- */
/*                  Atmel Microcontroller Software Support                      */
/*                       SAM Software Package License                           */
/* ---------------------------------------------------------------------------- */
/* Copyright (c) 2015, Atmel Corporation                                        */
/*                                                                              */
/* All rights reserved.                                                         */
/*                                                                              */
/* Redistribution and use in source and binary forms, with or without           */
/* modification, are permitted provided that the following condition is met:    */
/*                                                                              */
/* - Redistributions of source code must retain the above copyright notice,     */
/* this list of conditions and the disclaimer below.                            */
/*                                                                              */
/* Atmel's name may not be used to endorse or promote products derived from     */
/* this software without specific prior written permission.                     */
/*                                                                              */
/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
/* DISCLAIMED. IN NO EVENT SHALL ATMEL 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.                           */
/* ---------------------------------------------------------------------------- */
 
#ifndef _PIO_
#define _PIO_
 
/*
 *         Headers
 */
 
#include "chip.h"
 
#include <stdint.h>
 
/*
 *         Global Definitions
 */
 
#define PIO_PERIPH_A                0
#define PIO_PERIPH_B                1
#define PIO_PERIPH_C                2
#define PIO_PERIPH_D                3
#define PIO_INPUT                   4
#define PIO_OUTPUT_0                5
#define PIO_OUTPUT_1                6
 
#define PIO_DEFAULT                 (0 << 0)
#define PIO_PULLUP                  (1 << 0)
#define PIO_DEGLITCH                (1 << 1)
#define PIO_OPENDRAIN               (1 << 2)
 
#define PIO_DEBOUNCE                (1 << 3)
 
#define PIO_IT_AIME                 (1 << 4)
 
#define PIO_IT_RE_OR_HL             (1 << 5)
#define PIO_IT_EDGE                 (1 << 6)
 
#define PIO_IT_LOW_LEVEL          (0               | 0 | PIO_IT_AIME)
#define PIO_IT_HIGH_LEVEL         (PIO_IT_RE_OR_HL | 0 | PIO_IT_AIME)
#define PIO_IT_FALL_EDGE          (0               | PIO_IT_EDGE | PIO_IT_AIME)
#define PIO_IT_RISE_EDGE          (PIO_IT_RE_OR_HL | PIO_IT_EDGE | PIO_IT_AIME)
#define PIO_WPMR_WPEN_EN          (0x01     << 0)
#define PIO_WPMR_WPEN_DIS         (0x00     << 0)
#define PIO_WPMR_WPKEY_VALID      (0x50494F << 8)
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 *          Global Macros
 */
 
#define PIO_LISTSIZE(pPins)    (sizeof(pPins) / sizeof(Pin))
 
/*
 *         Global Types
 */
 
 
/*
 *  Describes the type and attribute of one PIO pin or a group of similar pins.
 *  The #type# field can have the following values:
 *     - PIO_PERIPH_A
 *     - PIO_PERIPH_B
 *     - PIO_OUTPUT_0
 *     - PIO_OUTPUT_1
 *     - PIO_INPUT
 *
 *  The #attribute# field is a bitmask that can either be set to PIO_DEFAULt,
 *  or combine (using bitwise OR '|') any number of the following constants:
 *     - PIO_PULLUP
 *     - PIO_DEGLITCH
 *     - PIO_DEBOUNCE
 *     - PIO_OPENDRAIN
 *     - PIO_IT_LOW_LEVEL
 *     - PIO_IT_HIGH_LEVEL
 *     - PIO_IT_FALL_EDGE
 *     - PIO_IT_RISE_EDGE
 */
typedef struct _Pin {
    /*  Bitmask indicating which pin(s) to configure. */
    uint32_t mask;
    /*  Pointer to the PIO controller which has the pin(s). */
    Pio    *pio;
    /*  Peripheral ID of the PIO controller which has the pin(s). */
    uint8_t id;
    /*  Pin type. */
    uint8_t type;
    /*  Pin attribute. */
    uint8_t attribute;
} Pin;
 
/*
 *         Global Access Macros
 */
 
/*
 *         Global Functions
 */
 
extern uint8_t PIO_Configure(const Pin *list, uint32_t size);
 
extern void PIO_Set(const Pin *pin);
 
extern void PIO_Clear(const Pin *pin);
 
extern uint8_t PIO_Get(const Pin *pin);
 
extern uint8_t PIO_GetOutputDataStatus(const Pin *pin);
 
extern void PIO_SetDebounceFilter(const Pin *pin, uint32_t cuttoff);
 
extern void PIO_EnableWriteProtect(const Pin *pin);
 
extern void PIO_DisableWriteProtect(const Pin *pin);
 
extern void PIO_SetPinType(Pin *pin, uint8_t pinType);
 
extern uint32_t PIO_GetWriteProtectViolationInfo(const Pin *pin);
 
extern void PIO_SetDriveStrength(const Pin *pin, uint8_t strength);
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef _PIO_ */