sergiotarxz/nuttx
sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
nuttx/arch/arm/src/samd5e5/sam_port.h
Alin Jerpelea 56471c77b3 arch: arm: sam: Author Gregory Nutt: update licenses to Apache 
Gregory Nutt has submitted the SGA and we can migrate the licenses
 to Apache.

Signed-off-by: Alin Jerpelea <alin.jerpelea@sony.com>
2021-03-28 13:34:50 -07:00

389 lines
16 KiB
C
Raw Blame History

/****************************************************************************
* arch/arm/src/samd5e5/sam_port.h
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __ARCH_ARM_SRC_SAMD5E5_SAM_PORT_H
#define __ARCH_ARM_SRC_SAMD5E5_SAM_PORT_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#ifndef __ASSEMBLY__
# include <stdint.h>
# include <stdbool.h>
#endif
#include <nuttx/irq.h>
#include "hardware/sam_port.h"
/****************************************************************************
* Pre-processor Declarations
****************************************************************************/
/* Bit-encoded input to sam_portconfig() */
/* 24-bit Encoding. This could be compacted into 16-bits by making the bit
* usage mode specific. However, by giving each bit field a unique position,
* we handle bad combinations of properties safely.
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: MMRR .... .S.. .... .PPB BBBB
* PORT Output: MM.. .... D..V .... .PPB BBBB
* Peripheral: MM.. FFFF ..O. II.. .PPB BBBB
* ------------ -----------------------------
* MMRR FFFF DSOV II.. .PPB BBBB
*/
/* Input/output/peripheral mode:
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: MM.. .... .... .... .... ....
* PORT Output: MM.. .... .... .... .... ....
* Peripheral: MM.. .... .... .... .... ....
*/
#define PORT_MODE_SHIFT (22) /* Bits 22-23: PORT mode */
#define PORT_MODE_MASK (3 << PORT_MODE_SHIFT)
# define PORT_INPUT (0 << PORT_MODE_SHIFT) /* PORT Input */
# define PORT_OUTPUT (1 << PORT_MODE_SHIFT) /* PORT Output */
# define PORT_PERIPHERAL (2 << PORT_MODE_SHIFT) /* Controlled by peripheral */
# define PORT_INTERRUPT (3 << PORT_MODE_SHIFT) /* Interrupting input */
#define PORT_MODE(n) ((uint8_t)(n) << PORT_MODE_SHIFT)
/* Pull-up/down resistor control for inputs
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: ..RR .... .... .... .... ....
* PORT Output: ..RR .... .... .... .... ....
* Peripheral: .... .... .... .... .... ....
*/
#define PORT_PULL_SHIFT (20) /* Bits 20-21: Pull-up/down resistor control */
#define PORT_PULL_MASK (3 << PORT_PULL_SHIFT)
# define PORT_PULL_NONE (0 << PORT_PULL_SHIFT)
# define PORT_PULL_UP (1 << PORT_PULL_SHIFT)
# define PORT_PULL_DOWN (2 << PORT_PULL_SHIFT)
/* Peripheral Function
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .... .... .... ....
* PORT Output: .... .... .... .... .... ....
* Peripheral: .... FFFF .... .... .... ....
*/
#define PORT_FUNC_SHIFT (16) /* Bits 16-19: Peripheral function */
#define PORT_FUNC_MASK (15 << PORT_FUNC_SHIFT)
# define _PORT_FUNCA (0 << PORT_FUNC_SHIFT) /* Function A */
# define _PORT_FUNCB (1 << PORT_FUNC_SHIFT) /* Function B */
# define _PORT_FUNCC (2 << PORT_FUNC_SHIFT) /* Function C */
# define _PORT_FUNCD (3 << PORT_FUNC_SHIFT) /* Function D */
# define _PORT_FUNCE (4 << PORT_FUNC_SHIFT) /* Function E */
# define _PORT_FUNCF (5 << PORT_FUNC_SHIFT) /* Function F */
# define _PORT_FUNCG (6 << PORT_FUNC_SHIFT) /* Function G */
# define _PORT_FUNCH (7 << PORT_FUNC_SHIFT) /* Function H */
# define _PORT_FUNCI (8 << PORT_FUNC_SHIFT) /* Function I */
# define _PORT_FUNCJ (9 << PORT_FUNC_SHIFT) /* Function J */
# define _PORT_FUNCK (10 << PORT_FUNC_SHIFT) /* Function K */
# define _PORT_FUNCL (11 << PORT_FUNC_SHIFT) /* Function L */
# define _PORT_FUNCM (12 << PORT_FUNC_SHIFT) /* Function M */
# define _PORT_FUNCN (13 << PORT_FUNC_SHIFT) /* Function N */
/* Extended input/output/peripheral mode:
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .... .... .... ....
* PORT Output: .... .... .... .... .... ....
* Peripheral: MM.. FFFF .... .... .... ....
*/
#define PORT_FUNCA (PORT_PERIPHERAL | _PORT_FUNCA) /* Function A */
#define PORT_FUNCB (PORT_PERIPHERAL | _PORT_FUNCB) /* Function B */
#define PORT_FUNCC (PORT_PERIPHERAL | _PORT_FUNCC) /* Function C */
#define PORT_FUNCD (PORT_PERIPHERAL | _PORT_FUNCD) /* Function D */
#define PORT_FUNCE (PORT_PERIPHERAL | _PORT_FUNCE) /* Function E */
#define PORT_FUNCF (PORT_PERIPHERAL | _PORT_FUNCF) /* Function F */
#define PORT_FUNCG (PORT_PERIPHERAL | _PORT_FUNCG) /* Function G */
#define PORT_FUNCH (PORT_PERIPHERAL | _PORT_FUNCH) /* Function H */
#define PORT_FUNCI (PORT_PERIPHERAL | _PORT_FUNCI) /* Function I */
#define PORT_FUNCJ (PORT_PERIPHERAL | _PORT_FUNCJ) /* Function J */
#define PORT_FUNCK (PORT_PERIPHERAL | _PORT_FUNCK) /* Function K */
#define PORT_FUNCL (PORT_PERIPHERAL | _PORT_FUNCL) /* Function L */
#define PORT_FUNCM (PORT_PERIPHERAL | _PORT_FUNCM) /* Function M */
#define PORT_FUNCN (PORT_PERIPHERAL | _PORT_FUNCN) /* Function N */
/* Output drive control
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .... .... .... ....
* PORT Output: .... .... D... .... .... ....
* Peripheral: .... .... .... .... .... ....
*/
#define PORT_DRIVE_SHIFT (15) /* Bit 15: Interrupting input control */
#define PORT_DRIVE_MASK (1 << PORT_INT_SHIFT)
# define PORT_DRIVE_LOW (0 << PORT_INT_SHIFT)
# define PORT_DRIVE_HIGH (1 << PORT_INT_SHIFT)
/* Input sampling
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .S.. .... .... ....
* PORT Output: .... .... .... .... .... ....
* Peripheral: .... .... .... .... .... ....
*/
#define PORT_SYNCHRONIZER_SHIFT (14) /* Bit 14: Input synchronizer input control */
#define PORT_SYNCHRONIZER_MASK (1 << PORT_SYNCHRONIZER_SHIFT)
# define PORT_SYNCHRONIZER_OFF (0 << PORT_SYNCHRONIZER_SHIFT)
# define PORT_SYNCHRONIZER_ON (1 << PORT_SYNCHRONIZER_SHIFT)
/* Output and Input Buffer both enabled to support readback of output pins.
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .... .... .... ....
* PORT Output: .... .... .... .... .... ....
* Peripheral: .... .... ..O. .... .... ....
*/
#define PORT_OUTREADBACK_SHIFT (13) /* Bit 13: Pin output and input buffer enabled */
#define PORT_OUTREADBACK_MASK (1 << PORT_OUTREADBACK_SHIFT)
# define PORT_OUTREADBACK_DISABLE (0 << PORT_OUTREADBACK_SHIFT)
# define PORT_OUTREADBACK_ENABLE (1 << PORT_OUTREADBACK_SHIFT)
/* If the pin is a PORT output, then this
* identifies the initial output value:
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .... .... .... ....
* PORT Output: .... .... ...V .... .... ....
* Peripheral: .... .... .... .... .... ....
*/
#define PORT_OUTVALUE_SHIFT (12) /* Bit 12: Initial value of output */
#define PORT_OUTVALUE_MASK (1 << PORT_OUTVALUE_SHIFT)
# define PORT_OUTPUT_CLEAR (0 << PORT_OUTVALUE_SHIFT)
# define PORT_OUTPUT_SET (1 << PORT_OUTVALUE_SHIFT)
/* Selections for external interrupts:
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .... .... .... ....
* PORT Output: .... .... .... .... .... ....
* Peripheral: .... .... .... II.. .... ....
*/
#define PORT_INT_SHIFT (10) /* Bits 10-11: Interrupting input control */
#define PORT_INT_MASK (3 << PORT_INT_SHIFT)
# define PORT_INT_CHANGE (0 << PORT_INT_SHIFT) /* Pin change */
# define PORT_INT_RISING (1 << PORT_INT_SHIFT) /* Rising edge */
# define PORT_INT_FALLING (2 << PORT_INT_SHIFT) /* Falling edge */
# define PORT_INT_BOTH (3 << PORT_INT_SHIFT) /* Both edge */
# define PORT_INT_HIGH (4 << PORT_INT_SHIFT) /* High edge */
/* This identifies the PORT port:
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .... .... .PP. ....
* PORT Output: .... .... .... .... .PP. ....
* Peripheral: .... .... .... .... .PP. ....
*/
#define PORT_SHIFT (5) /* Bits 5-6: Port number */
#define PORT_MASK (3 << PORT_SHIFT)
# define PORTA (SAM_PORTA << PORT_SHIFT)
# define PORTB (SAM_PORTB << PORT_SHIFT)
# define PORTC (SAM_PORTC << PORT_SHIFT)
# define PORTD (SAM_PORTD << PORT_SHIFT)
/* This identifies the bit in the port:
*
* MODE BITFIELDS
* ------------ -----------------------------
* 2222 1111 1111 1100 0000 0000
* 3210 9876 5432 1098 7654 3210
* ------------ -----------------------------
* PORT Input: .... .... .... .... ...B BBBB
* PORT Output: .... .... .... .... ...B BBBB
* Peripheral: .... .... .... .... ...B BBBB
*/
#define PORT_PIN_SHIFT 0 /* Bits 0-4: PORT number: 0-31 */
#define PORT_PIN_MASK (31 << PORT_PIN_SHIFT)
#define PORT_PIN0 (0 << PORT_PIN_SHIFT)
#define PORT_PIN1 (1 << PORT_PIN_SHIFT)
#define PORT_PIN2 (2 << PORT_PIN_SHIFT)
#define PORT_PIN3 (3 << PORT_PIN_SHIFT)
#define PORT_PIN4 (4 << PORT_PIN_SHIFT)
#define PORT_PIN5 (5 << PORT_PIN_SHIFT)
#define PORT_PIN6 (6 << PORT_PIN_SHIFT)
#define PORT_PIN7 (7 << PORT_PIN_SHIFT)
#define PORT_PIN8 (8 << PORT_PIN_SHIFT)
#define PORT_PIN9 (9 << PORT_PIN_SHIFT)
#define PORT_PIN10 (10 << PORT_PIN_SHIFT)
#define PORT_PIN11 (11 << PORT_PIN_SHIFT)
#define PORT_PIN12 (12 << PORT_PIN_SHIFT)
#define PORT_PIN13 (13 << PORT_PIN_SHIFT)
#define PORT_PIN14 (14 << PORT_PIN_SHIFT)
#define PORT_PIN15 (15 << PORT_PIN_SHIFT)
#define PORT_PIN16 (16 << PORT_PIN_SHIFT)
#define PORT_PIN17 (17 << PORT_PIN_SHIFT)
#define PORT_PIN18 (18 << PORT_PIN_SHIFT)
#define PORT_PIN19 (19 << PORT_PIN_SHIFT)
#define PORT_PIN20 (20 << PORT_PIN_SHIFT)
#define PORT_PIN21 (21 << PORT_PIN_SHIFT)
#define PORT_PIN22 (22 << PORT_PIN_SHIFT)
#define PORT_PIN23 (23 << PORT_PIN_SHIFT)
#define PORT_PIN24 (24 << PORT_PIN_SHIFT)
#define PORT_PIN25 (25 << PORT_PIN_SHIFT)
#define PORT_PIN26 (26 << PORT_PIN_SHIFT)
#define PORT_PIN27 (27 << PORT_PIN_SHIFT)
#define PORT_PIN28 (28 << PORT_PIN_SHIFT)
#define PORT_PIN29 (29 << PORT_PIN_SHIFT)
#define PORT_PIN30 (30 << PORT_PIN_SHIFT)
#define PORT_PIN31 (31 << PORT_PIN_SHIFT)
/****************************************************************************
* Public Types
****************************************************************************/
typedef uint32_t port_pinset_t;
/****************************************************************************
* Public Data
****************************************************************************/
#ifndef __ASSEMBLY__
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: sam_portconfig
*
* Description:
* Configure a PORT pin based on bit-encoded description of the pin.
*
* Returned Value:
* OK (always)
*
****************************************************************************/
int sam_portconfig(port_pinset_t pinset);
/****************************************************************************
* Name: sam_portwrite
*
* Description:
* Write one or zero to the selected PORT pin
*
****************************************************************************/
void sam_portwrite(port_pinset_t pinset, bool value);
/****************************************************************************
* Name: sam_portread
*
* Description:
* Read one or zero from the selected PORT pin
*
****************************************************************************/
bool sam_portread(port_pinset_t pinset);
/****************************************************************************
* Function: sam_dumpport
*
* Description:
* Dump all PORT registers associated with the provided pin description
* along with a descriptive message.
*
****************************************************************************/
#ifdef CONFIG_DEBUG_GPIO_INFO
int sam_dumpport(port_pinset_t pinset, const char *msg);
#else
# define sam_dumpport(p,m)
#endif
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* __ARCH_ARM_SRC_SAMD5E5_SAM_PORT_H */
Reference in New Issue View Git Blame Copy Permalink