diff options
Diffstat (limited to 'plat/freescale/common/include/sci/svc/pad/api.h')
| -rw-r--r--[-rwxr-xr-x] | plat/freescale/common/include/sci/svc/pad/api.h | 440 |
1 files changed, 238 insertions, 202 deletions
diff --git a/plat/freescale/common/include/sci/svc/pad/api.h b/plat/freescale/common/include/sci/svc/pad/api.h index d84f3fd8..fb6e78c1 100755..100644 --- a/plat/freescale/common/include/sci/svc/pad/api.h +++ b/plat/freescale/common/include/sci/svc/pad/api.h @@ -1,31 +1,8 @@ /* + * Copyright (C) 2016 Freescale Semiconductor, Inc. * Copyright 2017 NXP * - * 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 NXP 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 HOLDER 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. + * SPDX-License-Identifier: GPL-2.0+ */ /*! @@ -36,6 +13,37 @@ * * Module for the Pad Control (PAD) service. * + * @details + * + * Pad configuration is managed by SC firmware. The pad configuration + * features supported by the SC firmware include: + * + * - Configuring the mux, input/output connection, and low-power isolation + mode. + * - Configuring the technology-specific pad setting such as drive strength, + * pullup/pulldown, etc. + * - Configuring compensation for pad groups with dual voltage capability. + * + * Pad functions fall into one of three categories. Generic functions are + * common to all SoCs and all process technologies. SoC functions are raw + * low-level functions. Technology-specific functions are specific to the + * process technology. + * + * The list of pads is SoC specific. Refer to the SoC [Pad List](@ref PADS) + * for valid pad values. Note that all pads exist on a die but may or + * may not be brought out by the specific package. Mapping of pads to + * package pins/balls is documented in the associated Data Sheet. Some pads + * may not be brought out because the part (die+package) is defeatured and + * some pads may connect to the substrate in the package. + * + * Some pads (SC_P_COMP_*) that can be specified are not individual pads + * but are in fact pad groups. These groups have additional configuration + * that can be done using the sc_pad_set_gp_28fdsoi_comp() function. More + * info on these can be found in the associated Reference Manual. + * + * Pads are managed as a resource by the Resource Manager (RM). They have + * assigned owners and only the owners can configure the pads. + * * @{ */ @@ -49,6 +57,13 @@ /* Defines */ +/*! + * @name Defines for type widths + */ +/*@{*/ +#define SC_PAD_MUX_W 3 /*!< Width of mux parameter */ +/*@}*/ + /* Types */ /*! @@ -60,24 +75,24 @@ */ typedef enum sc_pad_config_e { - SC_PAD_CONFIG_NORMAL = 0, //!< Normal - SC_PAD_CONFIG_OD = 1, //!< Open Drain - SC_PAD_CONFIG_OD_IN = 2, //!< Open Drain and input - SC_PAD_CONFIG_OUT_IN = 3 //!< Output and input + SC_PAD_CONFIG_NORMAL = 0, /*!< Normal */ + SC_PAD_CONFIG_OD = 1, /*!< Open Drain */ + SC_PAD_CONFIG_OD_IN = 2, /*!< Open Drain and input */ + SC_PAD_CONFIG_OUT_IN = 3 /*!< Output and input */ } sc_pad_config_t; /*! * This type is used to declare a pad low-power isolation config. * ISO_LATE is the most common setting. ISO_EARLY is only used when - * an output pin is directly determined by another input pin. The + * an output pad is directly determined by another input pad. The * other two are only used when SW wants to directly contol isolation. */ typedef enum sc_pad_iso_e { - SC_PAD_ISO_OFF = 0, //!< ISO latch is transparent - SC_PAD_ISO_EARLY = 1, //!< Follow EARLY_ISO - SC_PAD_ISO_LATE = 2, //!< Follow LATE_ISO - SC_PAD_ISO_ON = 3 //!< ISO latched data is held + SC_PAD_ISO_OFF = 0, /*!< ISO latch is transparent */ + SC_PAD_ISO_EARLY = 1, /*!< Follow EARLY_ISO */ + SC_PAD_ISO_LATE = 2, /*!< Follow LATE_ISO */ + SC_PAD_ISO_ON = 3 /*!< ISO latched data is held */ } sc_pad_iso_t; /*! @@ -86,10 +101,10 @@ typedef enum sc_pad_iso_e */ typedef enum sc_pad_28lpp_dse_e { - SC_PAD_28LPP_DSE_x1 = 0, //!< Drive strength x1 - SC_PAD_28LPP_DSE_x4 = 1, //!< Drive strength x4 - SC_PAD_28LPP_DSE_x2 = 2, //!< Drive strength x2 - SC_PAD_28LPP_DSE_x6 = 3 //!< Drive strength x6 + SC_PAD_28LPP_DSE_x1 = 0, /*!< Drive strength x1 */ + SC_PAD_28LPP_DSE_x4 = 1, /*!< Drive strength x4 */ + SC_PAD_28LPP_DSE_x2 = 2, /*!< Drive strength x2 */ + SC_PAD_28LPP_DSE_x6 = 3 /*!< Drive strength x6 */ } sc_pad_28lpp_dse_t; /*! @@ -98,20 +113,20 @@ typedef enum sc_pad_28lpp_dse_e */ typedef enum sc_pad_28fdsio_dse_e { - SC_PAD_28FDSOI_DSE_18V_1MA = 0, //!< Drive strength of 1mA for 1.8v - SC_PAD_28FDSOI_DSE_33V_2MA = 0, //!< Drive strength of 2mA for 3.3v - SC_PAD_28FDSOI_DSE_DV_HIGH = 0, //!< Drive strength of 12mA for dual volt - SC_PAD_28FDSOI_DSE_18V_2MA = 1, //!< Drive strength of 2mA for 1.8v - SC_PAD_28FDSOI_DSE_33V_4MA = 1, //!< Drive strength of 4mA for 3.3v - SC_PAD_28FDSOI_DSE_DV_LOW = 1, //!< Drive strength of 12mA for dual volt - SC_PAD_28FDSOI_DSE_18V_4MA = 2, //!< Drive strength of 4mA for 1.8v - SC_PAD_28FDSOI_DSE_33V_8MA = 2, //!< Drive strength of 8mA for 3.3v - SC_PAD_28FDSOI_DSE_18V_6MA = 3, //!< Drive strength of 6mA for 1.8v - SC_PAD_28FDSOI_DSE_33V_12MA = 3, //!< Drive strength of 12mA for 3.3v - SC_PAD_28FDSOI_DSE_18V_8MA = 4, //!< Drive strength of 8mA for 1.8v - SC_PAD_28FDSOI_DSE_18V_10MA = 5, //!< Drive strength of 10mA for 1.8v - SC_PAD_28FDSOI_DSE_18V_12MA = 6, //!< Drive strength of 12mA for 1.8v - SC_PAD_28FDSOI_DSE_33V_HS = 7 //!< High-speed drive strength for 1.8v + SC_PAD_28FDSOI_DSE_18V_1MA = 0, /*!< Drive strength of 1mA for 1.8v */ + SC_PAD_28FDSOI_DSE_18V_2MA = 1, /*!< Drive strength of 2mA for 1.8v */ + SC_PAD_28FDSOI_DSE_18V_4MA = 2, /*!< Drive strength of 4mA for 1.8v */ + SC_PAD_28FDSOI_DSE_18V_6MA = 3, /*!< Drive strength of 6mA for 1.8v */ + SC_PAD_28FDSOI_DSE_18V_8MA = 4, /*!< Drive strength of 8mA for 1.8v */ + SC_PAD_28FDSOI_DSE_18V_10MA = 5, /*!< Drive strength of 10mA for 1.8v */ + SC_PAD_28FDSOI_DSE_18V_12MA = 6, /*!< Drive strength of 12mA for 1.8v */ + SC_PAD_28FDSOI_DSE_33V_2MA = 0, /*!< Drive strength of 2mA for 3.3v */ + SC_PAD_28FDSOI_DSE_33V_4MA = 1, /*!< Drive strength of 4mA for 3.3v */ + SC_PAD_28FDSOI_DSE_33V_8MA = 2, /*!< Drive strength of 8mA for 3.3v */ + SC_PAD_28FDSOI_DSE_33V_12MA = 3, /*!< Drive strength of 12mA for 3.3v */ + SC_PAD_28FDSOI_DSE_33V_HS = 7, /*!< High-speed drive strength for 1.8v */ + SC_PAD_28FDSOI_DSE_DV_LOW = 0, /*!< Low drive strength for dual volt */ + SC_PAD_28FDSOI_DSE_DV_HIGH = 1 /*!< High drive strength for dual volt */ } sc_pad_28fdsoi_dse_t; /*! @@ -120,10 +135,10 @@ typedef enum sc_pad_28fdsio_dse_e */ typedef enum sc_pad_28lpp_ps_e { - SC_PAD_28LPP_PS_PD = 0, //!< Pull down - SC_PAD_28LPP_PS_PU_5K = 1, //!< 5K pull up - SC_PAD_28LPP_PS_PU_47K = 2, //!< 47K pull up - SC_PAD_28LPP_PS_PU_100K = 3 //!< 100K pull up + SC_PAD_28LPP_PS_PD = 0, /*!< Pull down */ + SC_PAD_28LPP_PS_PU_5K = 1, /*!< 5K pull up */ + SC_PAD_28LPP_PS_PU_47K = 2, /*!< 47K pull up */ + SC_PAD_28LPP_PS_PU_100K = 3 /*!< 100K pull up */ } sc_pad_28lpp_ps_t; /*! @@ -132,33 +147,38 @@ typedef enum sc_pad_28lpp_ps_e */ typedef enum sc_pad_28fdsoi_ps_e { - SC_PAD_28FDSOI_PS_KEEPER = 0, //!< Bus-keeper (only valid for 1.8v) - SC_PAD_28FDSOI_PS_PU = 1, //!< Pull-up - SC_PAD_28FDSOI_PS_PD = 2, //!< Pull-down - SC_PAD_28FDSOI_PS_NONE = 3 //!< No pull (disabled) + SC_PAD_28FDSOI_PS_KEEPER = 0, /*!< Bus-keeper (only valid for 1.8v) */ + SC_PAD_28FDSOI_PS_PU = 1, /*!< Pull-up */ + SC_PAD_28FDSOI_PS_PD = 2, /*!< Pull-down */ + SC_PAD_28FDSOI_PS_NONE = 3 /*!< No pull (disabled) */ } sc_pad_28fdsoi_ps_t; /*! - * This type is used to declare a wakeup mode of a pin. + * This type is used to declare a wakeup mode of a pad. */ typedef enum sc_pad_wakeup_e { - SC_PAD_WAKEUP_OFF = 0, //!< Off - SC_PAD_WAKEUP_CLEAR = 1, //!< Clears pending flag - SC_PAD_WAKEUP_LOW_LVL = 4, //!< Low level - SC_PAD_WAKEUP_FALL_EDGE = 5, //!< Falling edge - SC_PAD_WAKEUP_RISE_EDGE = 6, //!< Rising edge - SC_PAD_WAKEUP_HIGH_LVL = 7 //!< High-level + SC_PAD_WAKEUP_OFF = 0, /*!< Off */ + SC_PAD_WAKEUP_CLEAR = 1, /*!< Clears pending flag */ + SC_PAD_WAKEUP_LOW_LVL = 4, /*!< Low level */ + SC_PAD_WAKEUP_FALL_EDGE = 5, /*!< Falling edge */ + SC_PAD_WAKEUP_RISE_EDGE = 6, /*!< Rising edge */ + SC_PAD_WAKEUP_HIGH_LVL = 7 /*!< High-level */ } sc_pad_wakeup_t; /* Functions */ /*! - * This function configures the mux settings for a pin. This includes + * @name Generic Functions + * @{ + */ + +/*! + * This function configures the mux settings for a pad. This includes * the signal mux, pad config, and low-power isolation mode. * * @param[in] ipc IPC handle - * @param[in] pin pin to configure + * @param[in] pad pad to configure * @param[in] mux mux setting * @param[in] config pad config * @param[in] iso low-power isolation mode @@ -167,80 +187,115 @@ typedef enum sc_pad_wakeup_e * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner + * - SC_ERR_NOACCESS if caller's partition is not the pad owner * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_set_mux(sc_ipc_t ipc, sc_pin_t pin, +sc_err_t sc_pad_set_mux(sc_ipc_t ipc, sc_pad_t pad, uint8_t mux, sc_pad_config_t config, sc_pad_iso_t iso); /*! + * This function gets the mux settings for a pad. This includes + * the signal mux, pad config, and low-power isolation mode. + * + * @param[in] ipc IPC handle + * @param[in] pad pad to query + * @param[out] mux pointer to return mux setting + * @param[out] config pointer to return pad config + * @param[out] iso pointer to return low-power isolation mode + * + * @return Returns an error code (SC_ERR_NONE = success). + * + * Return errors: + * - SC_PARM if arguments out of range or invalid, + * - SC_ERR_NOACCESS if caller's partition is not the pad owner + * + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. + */ +sc_err_t sc_pad_get_mux(sc_ipc_t ipc, sc_pad_t pad, + uint8_t *mux, sc_pad_config_t *config, sc_pad_iso_t *iso); + +/*! * This function configures the general purpose pad control. This * is technology dependent and includes things like drive strength, * slew rate, pull up/down, etc. Refer to the SoC Reference Manual * for bit field details. * * @param[in] ipc IPC handle - * @param[in] pin pin to configure + * @param[in] pad pad to configure * @param[in] ctrl control value to set * * @return Returns an error code (SC_ERR_NONE = success). * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner + * - SC_ERR_NOACCESS if caller's partition is not the pad owner * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_set_gp(sc_ipc_t ipc, sc_pin_t pin, uint32_t ctrl); +sc_err_t sc_pad_set_gp(sc_ipc_t ipc, sc_pad_t pad, uint32_t ctrl); /*! - * This function configures the pad control specific to 28LPP. + * This function gets the general purpose pad control. This + * is technology dependent and includes things like drive strength, + * slew rate, pull up/down, etc. Refer to the SoC Reference Manual + * for bit field details. * * @param[in] ipc IPC handle - * @param[in] pin pin to configure - * @param[in] dse drive strength - * @param[in] sre slew rate - * @param[in] hys hysteresis - * @param[in] pe pull enable - * @param[in] ps pull select + * @param[in] pad pad to query + * @param[out] ctrl pointer to return control value * * @return Returns an error code (SC_ERR_NONE = success). * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner, - * - SC_ERR_UNAVAILABLE if process not applicable + * - SC_ERR_NOACCESS if caller's partition is not the pad owner * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_set_gp_28lpp(sc_ipc_t ipc, sc_pin_t pin, - sc_pad_28lpp_dse_t dse, bool sre, bool hys, bool pe, - sc_pad_28lpp_ps_t ps); +sc_err_t sc_pad_get_gp(sc_ipc_t ipc, sc_pad_t pad, uint32_t *ctrl); /*! - * This function configures the wakeup mode of the pin. + * This function configures the wakeup mode of the pad. * * @param[in] ipc IPC handle - * @param[in] pin pin to configure + * @param[in] pad pad to configure * @param[in] wakeup wakeup to set * * @return Returns an error code (SC_ERR_NONE = success). * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner + * - SC_ERR_NOACCESS if caller's partition is not the pad owner * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_set_wakeup(sc_ipc_t ipc, sc_pin_t pin, +sc_err_t sc_pad_set_wakeup(sc_ipc_t ipc, sc_pad_t pad, sc_pad_wakeup_t wakeup); /*! + * This function gets the wakeup mode of a pad. + * + * @param[in] ipc IPC handle + * @param[in] pad pad to query + * @param[out] wakeup pointer to return wakeup + * + * @return Returns an error code (SC_ERR_NONE = success). + * + * Return errors: + * - SC_PARM if arguments out of range or invalid, + * - SC_ERR_NOACCESS if caller's partition is not the pad owner + * + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. + */ +sc_err_t sc_pad_get_wakeup(sc_ipc_t ipc, sc_pad_t pad, + sc_pad_wakeup_t *wakeup); + +/*! * This function configures a pad. * * @param[in] ipc IPC handle - * @param[in] pin pin to configure + * @param[in] pad pad to configure * @param[in] mux mux setting * @param[in] config pad config * @param[in] iso low-power isolation mode @@ -252,130 +307,145 @@ sc_err_t sc_pad_set_wakeup(sc_ipc_t ipc, sc_pin_t pin, * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner + * - SC_ERR_NOACCESS if caller's partition is not the pad owner * * @return Returns an error code (SC_ERR_NONE = success). * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_set_all(sc_ipc_t ipc, sc_pin_t pin, uint8_t mux, +sc_err_t sc_pad_set_all(sc_ipc_t ipc, sc_pad_t pad, uint8_t mux, sc_pad_config_t config, sc_pad_iso_t iso, uint32_t ctrl, sc_pad_wakeup_t wakeup); /*! - * This function gets the mux settings for a pin. This includes - * the signal mux, pad config, and low-power isolation mode. + * This function gets a pad's config. * * @param[in] ipc IPC handle - * @param[in] pin pin to query + * @param[in] pad pad to query * @param[out] mux pointer to return mux setting * @param[out] config pointer to return pad config * @param[out] iso pointer to return low-power isolation mode + * @param[out] ctrl pointer to return control value + * @param[out] wakeup pointer to return wakeup to set * - * @return Returns an error code (SC_ERR_NONE = success). + * @see sc_pad_set_mux(). + * @see sc_pad_set_gp(). * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner + * - SC_ERR_NOACCESS if caller's partition is not the pad owner * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * @return Returns an error code (SC_ERR_NONE = success). + * + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_get_mux(sc_ipc_t ipc, sc_pin_t pin, - uint8_t *mux, sc_pad_config_t *config, sc_pad_iso_t *iso); +sc_err_t sc_pad_get_all(sc_ipc_t ipc, sc_pad_t pad, uint8_t *mux, + sc_pad_config_t *config, sc_pad_iso_t *iso, uint32_t *ctrl, + sc_pad_wakeup_t *wakeup); + +/* @} */ /*! - * This function gets the general purpose pad control. This - * is technology dependent and includes things like drive strength, - * slew rate, pull up/down, etc. Refer to the SoC Reference Manual - * for bit field details. + * @name SoC Specific Functions + * @{ + */ + +/*! + * This function configures the settings for a pad. This setting is SoC + * specific. * * @param[in] ipc IPC handle - * @param[in] pin pin to query - * @param[out] ctrl pointer to return control value + * @param[in] pad pad to configure + * @param[in] val value to set * * @return Returns an error code (SC_ERR_NONE = success). * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner + * - SC_ERR_NOACCESS if caller's partition is not the pad owner * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_get_gp(sc_ipc_t ipc, sc_pin_t pin, uint32_t *ctrl); +sc_err_t sc_pad_set(sc_ipc_t ipc, sc_pad_t pad, uint32_t val); /*! - * This function gets the pad control specific to 28LPP. + * This function gets the settings for a pad. This setting is SoC + * specific. * * @param[in] ipc IPC handle - * @param[in] pin pin to query - * @param[out] dse pointer to return drive strength - * @param[out] sre pointer to return slew rate - * @param[out] hys pointer to return hysteresis - * @param[out] pe pointer to return pull enable - * @param[out] ps pointer to return pull select + * @param[in] pad pad to query + * @param[out] val pointer to return setting * * @return Returns an error code (SC_ERR_NONE = success). * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner, - * - SC_ERR_UNAVAILABLE if process not applicable + * - SC_ERR_NOACCESS if caller's partition is not the pad owner * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_get_gp_28lpp(sc_ipc_t ipc, sc_pin_t pin, - sc_pad_28lpp_dse_t *dse, bool *sre, bool *hys, bool *pe, - sc_pad_28lpp_ps_t *ps); +sc_err_t sc_pad_get(sc_ipc_t ipc, sc_pad_t pad, uint32_t *val); + +/* @} */ /*! - * This function gets the wakeup mode of a pin. + * @name Technology Specific Functions + * @{ + */ + +/*! + * This function configures the pad control specific to 28LPP. * * @param[in] ipc IPC handle - * @param[in] pin pin to query - * @param[out] wakeup pointer to return wakeup + * @param[in] pad pad to configure + * @param[in] dse drive strength + * @param[in] sre slew rate + * @param[in] hys hysteresis + * @param[in] pe pull enable + * @param[in] ps pull select * * @return Returns an error code (SC_ERR_NONE = success). * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner + * - SC_ERR_NOACCESS if caller's partition is not the pad owner, + * - SC_ERR_UNAVAILABLE if process not applicable * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_get_wakeup(sc_ipc_t ipc, sc_pin_t pin, - sc_pad_wakeup_t *wakeup); +sc_err_t sc_pad_set_gp_28lpp(sc_ipc_t ipc, sc_pad_t pad, + sc_pad_28lpp_dse_t dse, bool sre, bool hys, bool pe, + sc_pad_28lpp_ps_t ps); /*! - * This function gets a pad's config. + * This function gets the pad control specific to 28LPP. * * @param[in] ipc IPC handle - * @param[in] pin pin to query - * @param[out] mux pointer to return mux setting - * @param[out] config pointer to return pad config - * @param[out] iso pointer to return low-power isolation mode - * @param[out] ctrl pointer to return control value - * @param[out] wakeup pointer to return wakeup to set + * @param[in] pad pad to query + * @param[out] dse pointer to return drive strength + * @param[out] sre pointer to return slew rate + * @param[out] hys pointer to return hysteresis + * @param[out] pe pointer to return pull enable + * @param[out] ps pointer to return pull select * - * @see sc_pad_set_mux(). - * @see sc_pad_set_gp(). + * @return Returns an error code (SC_ERR_NONE = success). * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner - * - * @return Returns an error code (SC_ERR_NONE = success). + * - SC_ERR_NOACCESS if caller's partition is not the pad owner, + * - SC_ERR_UNAVAILABLE if process not applicable * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_get_all(sc_ipc_t ipc, sc_pin_t pin, uint8_t *mux, - sc_pad_config_t *config, sc_pad_iso_t *iso, uint32_t *ctrl, - sc_pad_wakeup_t *wakeup); +sc_err_t sc_pad_get_gp_28lpp(sc_ipc_t ipc, sc_pad_t pad, + sc_pad_28lpp_dse_t *dse, bool *sre, bool *hys, bool *pe, + sc_pad_28lpp_ps_t *ps); /*! * This function configures the pad control specific to 28FDSOI. * * @param[in] ipc IPC handle - * @param[in] pin pin to configure + * @param[in] pad pad to configure * @param[in] dse drive strength * @param[in] ps pull select * @@ -383,19 +453,19 @@ sc_err_t sc_pad_get_all(sc_ipc_t ipc, sc_pin_t pin, uint8_t *mux, * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner, + * - SC_ERR_NOACCESS if caller's partition is not the pad owner, * - SC_ERR_UNAVAILABLE if process not applicable * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_set_gp_28fdsoi(sc_ipc_t ipc, sc_pin_t pin, +sc_err_t sc_pad_set_gp_28fdsoi(sc_ipc_t ipc, sc_pad_t pad, sc_pad_28fdsoi_dse_t dse, sc_pad_28fdsoi_ps_t ps); /*! * This function gets the pad control specific to 28FDSOI. * * @param[in] ipc IPC handle - * @param[in] pin pin to query + * @param[in] pad pad to query * @param[out] dse pointer to return drive strength * @param[out] ps pointer to return pull select * @@ -403,19 +473,19 @@ sc_err_t sc_pad_set_gp_28fdsoi(sc_ipc_t ipc, sc_pin_t pin, * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner, + * - SC_ERR_NOACCESS if caller's partition is not the pad owner, * - SC_ERR_UNAVAILABLE if process not applicable * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_get_gp_28fdsoi(sc_ipc_t ipc, sc_pin_t pin, +sc_err_t sc_pad_get_gp_28fdsoi(sc_ipc_t ipc, sc_pad_t pad, sc_pad_28fdsoi_dse_t *dse, sc_pad_28fdsoi_ps_t *ps); /*! * This function configures the compensation control specific to 28FDSOI. * * @param[in] ipc IPC handle - * @param[in] pin pin to configure + * @param[in] pad pad to configure * @param[in] compen compensation/freeze mode * @param[in] fastfrz fast freeze * @param[in] rasrcp compensation code for PMOS @@ -426,12 +496,12 @@ sc_err_t sc_pad_get_gp_28fdsoi(sc_ipc_t ipc, sc_pin_t pin, * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner, + * - SC_ERR_NOACCESS if caller's partition is not the pad owner, * - SC_ERR_UNAVAILABLE if process not applicable * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_set_gp_28fdsoi_comp(sc_ipc_t ipc, sc_pin_t pin, +sc_err_t sc_pad_set_gp_28fdsoi_comp(sc_ipc_t ipc, sc_pad_t pad, uint8_t compen, bool fastfrz, uint8_t rasrcp, uint8_t rasrcn, bool nasrc_sel); @@ -439,7 +509,7 @@ sc_err_t sc_pad_set_gp_28fdsoi_comp(sc_ipc_t ipc, sc_pin_t pin, * This function gets the compensation control specific to 28FDSOI. * * @param[in] ipc IPC handle - * @param[in] pin pin to query + * @param[in] pad pad to query * @param[in] compen pointer to return compensation/freeze mode * @param[in] fastfrz pointer to return fast freeze * @param[in] rasrcp pointer to return compensation code for PMOS @@ -452,50 +522,16 @@ sc_err_t sc_pad_set_gp_28fdsoi_comp(sc_ipc_t ipc, sc_pin_t pin, * * Return errors: * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner, + * - SC_ERR_NOACCESS if caller's partition is not the pad owner, * - SC_ERR_UNAVAILABLE if process not applicable * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. + * Refer to the SoC [Pad List](@ref PADS) for valid pad values. */ -sc_err_t sc_pad_get_gp_28fdsoi_comp(sc_ipc_t ipc, sc_pin_t pin, +sc_err_t sc_pad_get_gp_28fdsoi_comp(sc_ipc_t ipc, sc_pad_t pad, uint8_t *compen, bool *fastfrz, uint8_t *rasrcp, uint8_t *rasrcn, bool *nasrc_sel, bool *compok, uint8_t *nasrc); -/*! - * This function configures the settings for a pin. This setting is SoC - * specific. - * - * @param[in] ipc IPC handle - * @param[in] pin pin to configure - * @param[in] val value to set - * - * @return Returns an error code (SC_ERR_NONE = success). - * - * Return errors: - * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner - * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. - */ -sc_err_t sc_pad_set(sc_ipc_t ipc, sc_pin_t pin, uint32_t val); - -/*! - * This function gets the settings for a pin. This setting is SoC - * specific. - * - * @param[in] ipc IPC handle - * @param[in] pin pin to query - * @param[out] val pointer to return setting - * - * @return Returns an error code (SC_ERR_NONE = success). - * - * Return errors: - * - SC_PARM if arguments out of range or invalid, - * - SC_ERR_NOACCESS if caller's partition is not the pin owner - * - * Refer to the SoC [Pin List](@ref PINS) for valid pin values. - */ -sc_err_t sc_pad_get(sc_ipc_t ipc, sc_pin_t pin, uint32_t *val); +/* @} */ #endif /* _SC_PAD_API_H */ |