/*
|
* Copyright (c) 2019-2023 Beijing Hanwei Innovation Technology Ltd. Co. and
|
* its subsidiaries and affiliates (collectly called MKSEMI).
|
*
|
* All rights reserved.
|
*
|
* Redistribution and use in source and binary forms, with or without
|
* modification, are permitted provided that the following conditions are met:
|
*
|
* 1. Redistributions of source code must retain the above copyright notice,
|
* this list of conditions and the following disclaimer.
|
*
|
* 2. Redistributions in binary form, except as embedded into an MKSEMI
|
* integrated circuit in a product or a software update for such product,
|
* 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.
|
*
|
* 3. Neither the name of MKSEMI nor the names of its contributors may be used
|
* to endorse or promote products derived from this software without
|
* specific prior written permission.
|
*
|
* 4. This software, with or without modification, must only be used with a
|
* MKSEMI integrated circuit.
|
*
|
* 5. Any software provided in binary form under this license must not be
|
* reverse engineered, decompiled, modified and/or disassembled.
|
*
|
* THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
* MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
* DISCLAIMED. IN NO EVENT SHALL MKSEMI 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 MK_IO_H_
|
#define MK_IO_H_
|
|
#include "mk_common.h"
|
|
/**
|
* @addtogroup MK8000_IO
|
* @brief IO function, mode and drive selection definitions
|
* @{
|
*/
|
|
/** IO pin index */
|
enum IO_PIN_T
|
{
|
IO_PIN_0 = 0,
|
IO_PIN_1,
|
IO_PIN_2,
|
IO_PIN_3,
|
IO_PIN_4,
|
IO_PIN_5,
|
IO_PIN_6,
|
IO_PIN_7,
|
|
IO_PIN_8,
|
IO_PIN_9,
|
IO_PIN_10,
|
IO_PIN_11,
|
IO_PIN_12,
|
IO_PIN_13,
|
IO_PIN_14,
|
IO_PIN_15,
|
|
IO_PIN_16,
|
IO_PIN_17,
|
|
IO_PIN_MAX
|
};
|
|
/** IO pin function selections */
|
enum IO_FUNC_T
|
{
|
IO_FUNC0 = 0, /*!< Selects pin function 0 */
|
IO_FUNC1, /*!< Selects pin function 1 */
|
IO_FUNC2, /*!< Selects pin function 2 */
|
IO_FUNC3, /*!< Selects pin function 3 */
|
IO_FUNC4, /*!< Selects pin function 4 */
|
IO_FUNC5, /*!< Selects pin function 5 */
|
IO_FUNC6, /*!< Selects pin function 6 */
|
IO_FUNC7, /*!< Selects pin function 7 */
|
IO_FUNC8, /*!< Selects pin function 8 */
|
};
|
|
/** IO drive level */
|
enum IO_DRV_T
|
{
|
IO_DRV_NORMAL = 0,
|
IO_DRV_HIGH,
|
};
|
|
/** IO pull up/down modes */
|
enum IO_PULL_MODE_T
|
{
|
IO_PULL_UP = 0,
|
IO_PULL_DOWN,
|
IO_HIGH_Z,
|
};
|
|
/** IO pull up levels */
|
enum IO_PULL_UP_LEVEL_T
|
{
|
IO_PULL_UP_NONE = 0, // High-Z
|
IO_PULL_UP_LEVEL0 = 1, // 100K+
|
IO_PULL_UP_LEVEL1 = 2, // 24k
|
IO_PULL_UP_LEVEL2 = 3, // 12k
|
IO_PULL_UP_LEVEL3 = 4, // 6k
|
IO_PULL_UP_LEVEL4 = 5, // 1.5k
|
};
|
|
#if defined(__cplusplus)
|
extern "C" {
|
#endif
|
|
/**
|
* @brief set IO pin function.
|
*
|
* @param[in] pin Pin to be set
|
* @param[in] func Pin function to be set
|
*/
|
void io_pin_mux_set(enum IO_PIN_T pin, enum IO_FUNC_T func);
|
|
/**
|
* @brief enable IO pin open drain mode.
|
*
|
* @param[in] pin Pin to be set
|
* @param[in] en Enable open drain mode
|
*/
|
void io_open_drain_set(enum IO_PIN_T pin, bool en);
|
|
/**
|
* @brief set IO pin drive capability.
|
*
|
* @param[in] pin Pin to be set
|
* @param[in] strength Drive strength level
|
*/
|
void io_drive_set(enum IO_PIN_T pin, enum IO_DRV_T strength);
|
|
/**
|
* @brief set IO pin pull up/down mode.
|
*
|
* @param[in] pin Pin to be set
|
* @param[in] pull_mode Pull up/down mode
|
* @param[in] pull_up_level Pull up level, only applicable while set to pull up mode
|
*/
|
void io_pull_set(enum IO_PIN_T pin, enum IO_PULL_MODE_T pull_mode, enum IO_PULL_UP_LEVEL_T pull_up_level);
|
|
#if defined(__cplusplus)
|
}
|
#endif
|
|
/**
|
* @}
|
*/
|
|
#endif /* MK_IO_H_ */
|
