[processor-sdk/performance-audio-sr.git] / pdk_k2g_1_0_1_0_eng / packages / ti / board / src / flash / platform_flash / evmc66x_pinmux.h
1 /*
2 * Copyright (c) 2015, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
34 /**
35 *
36 * \file evmc66x_pinmux.h
37 *
38 * \brief This file is the header file for pin mux module
39 *
40 ******************************************************************************/
42 #ifndef _EVMC66X_PINMUX_H_
43 #define _EVMC66X_PINMUX_H_
45 /** Maximum number of pad config registers supported */
46 #define PADCONFIG_MAX_COUNT (260)
48 /**
49 * \brief Mux mode selection for pad config registers
50 */
51 typedef enum _PadCfgMuxMode
52 {
53 PADCONFIG_MUX_MODE_PRIMARY = 0, /**< Primary pin mux mode */
54 PADCONFIG_MUX_MODE_SECONDARY, /**< Secondary pin mux mode */
55 PADCONFIG_MUX_MODE_TERTIARY, /**< Tertiary pin mux mode */
56 PADCONFIG_MUX_MODE_QUATERNARY, /**< Quaternary pin mux mode */
57 PADCONFIG_MUX_MODE_QUINARY, /**< Quinary pin mux mode */
58 PADCONFIG_MUX_MODE_SENARY /**< Senary pin mux mode */
60 } PadCfgMuxMode;
62 /**
63 * \brief Configures default mode for pin muxing in pad config registers
64 *
65 * \return none
66 */
67 void pinMuxInit(void);
69 /**
70 * \brief Configures pin mux mode of a pad config register
71 *
72 * \param padCfgId [IN] Pad config register Id; 0 - 259
73 * \param muxMode [IN] Pad config mux mode
74 *
75 * \return
76 * \n 0 - Mux mode configuration is successful
77 * \n -1 - Invalid parameter
78 */
79 int32_t plat_pinMuxSetMode(uint16_t padCfgId, PadCfgMuxMode muxMode);
81 #endif /* _EVMC66X_PINMUX_H_ */
83 /* Nothing past this point */