pinmux/v0/pinmux.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Texas Instruments Incorporated
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of
 * its contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS 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 PINMUX_XWRL64XX_H_
#define PINMUX_XWRL64XX_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define PINMUX_DOMAIN_ID_MAIN           (0U)
 
#define PINMUX_DOMAIN_ID_MCU            (1U)
 
#define PINMUX_END                      (0xFFFFFFFFU)
 
#define PIN_MODE(mode)                  (mode)
 
#define PIN_PULL_DISABLE                (0x1U << 8U)
 
#define PIN_PULL_DIRECTION              (0x1U << 9U)
 
#define PIN_PAD_AA          (0x00000000U)
#define PIN_PAD_AB          (0x00000004U)
#define PIN_PAD_AC          (0x00000008U)
#define PIN_PAD_AD          (0x0000000CU)
#define PIN_PAD_AE          (0x00000010U)
#define PIN_PAD_AF          (0x00000014U)
#define PIN_PAD_AG          (0x00000018U)
#define PIN_PAD_AH          (0x0000001CU)
#define PIN_PAD_AI          (0x00000020U)
#define PIN_PAD_AJ          (0x00000024U)
#define PIN_PAD_AK          (0x00000028U)
#define PIN_PAD_AL          (0x0000002CU)
#define PIN_PAD_AM          (0x00000030U)
#define PIN_PAD_AN          (0x00000034U)
#define PIN_PAD_AO          (0x00000038U)
#define PIN_PAD_AP          (0x0000003CU)
#define PIN_PAD_AQ          (0x00000040U)
#define PIN_PAD_AR          (0x00000044U)
#define PIN_PAD_AS          (0x00000048U)
#define PIN_PAD_AT          (0x0000004CU)
#define PIN_PAD_AU          (0x00000050U)
#define PIN_PAD_AV          (0x00000054U)
#define PIN_PAD_AW          (0x00000058U)
#define PIN_PAD_AX          (0x0000005CU)
 
 
/* pin names */
#define PIN_OVERRIDE_INPUT_ENABLE                 (0x1 << 5U)
#define PIN_OVERRIDE_INPUT_ENABLE_CTRL            (0x1 << 4U)
 
#define PIN_OVERRIDE_OUTPUT_DISABLE               (0x1 << 7U)
#define PIN_OVERRIDE_OUTPUT_DISABLE_CTRL          (0x1 << 6U)
 
#define PIN_SLEW_RATE_HIGH                        (0x0U << 10U)
 
#define PIN_SLEW_RATE_LOW                         (0x1U << 10U)
 
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct Pinmux_PerCfg
{
    uint32_t    offset;
    uint32_t    settings;
} Pinmux_PerCfg_t;
 
typedef struct PadToPin
{
    uint32_t Pad;
 
    uint32_t gpioNum;
 
    uint32_t mode;
}PadToPin_t;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Pinmux_config(const Pinmux_PerCfg_t *pinmuxCfg, uint32_t domainId);
uint32_t Pinmux_Read(uint32_t pinOffset);
uint32_t Pinmux_getMode(uint32_t pad);
uint32_t Pinmux_getPinNum(uint32_t pad);
 
void Pinmux_inputoverride(uint32_t offset, bool state);
 
void Pinmux_outputoverride(uint32_t offset, bool state);
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef PINMUX_AM64X_H_ */