Dio.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2023 Texas Instruments Incorporated
*
* All rights reserved not granted herein.
*
* Limited License.
*
* Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
* license under copyrights and patents it now or hereafter owns or controls to make,
* have made, use, import, offer to sell and sell ("Utilize") this software subject to the
* terms herein.  With respect to the foregoing patent license, such license is granted
* solely to the extent that any such patent is necessary to Utilize the software alone.
* The patent license shall not apply to any combinations which include this software,
* other than combinations with devices manufactured by or for TI ("TI Devices").
* No hardware patent is licensed hereunder.
*
* Redistributions must preserve existing copyright notices and reproduce this license
* (including the above copyright notice and the disclaimer and (if applicable) source
* code license limitations below) in the documentation and/or other materials provided
* with the distribution
*
* Redistribution and use in binary form, without modification, are permitted provided
* that the following conditions are met:
*
* *       No reverse engineering, decompilation, or disassembly of this software is
* permitted with respect to any software provided in binary form.
*
* *       any redistribution and use are licensed by TI for use only with TI Devices.
*
* *       Nothing shall obligate TI to provide you with source code for the software
* licensed and provided to you in object code.
*
* If software source code is provided to you, modification and redistribution of the
* source code are permitted provided that the following conditions are met:
*
* *       any redistribution and use of the source code, including any resulting derivative
* works, are licensed by TI for use only with TI Devices.
*
* *       any redistribution and use of any object code compiled from the source code
* and any resulting derivative works, are licensed by TI for use only with TI Devices.
*
* Neither the name of Texas Instruments Incorporated nor the names of its suppliers
*
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* DISCLAIMER.
*
* THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "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 TI AND TI'S LICENSORS 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.
*
*/

/*
 * Below are the global requirements which are met by this DIO
 * driver which can't be mapped to a particular source ID
 */
/*
 * Design: MCAL-5468,MCAL-5428
 */
#ifndef DIO_H_
#define DIO_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

/*
 * Design: MCAL-5509
 */
#include "Std_Types.h"
/*
 * Design: MCAL-5492,MCAL-5461
 */
#include "Dio_Cfg.h"

#ifdef __cplusplus
extern "C"
{
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

#define DIO_SW_MAJOR_VERSION            (9U)

#define DIO_SW_MINOR_VERSION            (0U)

#define DIO_SW_PATCH_VERSION            (0U)
/* @} */

#define DIO_AR_RELEASE_MAJOR_VERSION    (4U)

#define DIO_AR_RELEASE_MINOR_VERSION    (3U)

#define DIO_AR_RELEASE_REVISION_VERSION (1U)
/* @} */

#define DIO_VENDOR_ID                   ((uint16) 44U)

#define DIO_MODULE_ID                   ((uint16) 120U)
/* @} */

/*
 * Design: MCAL-5443
 */
#ifndef DIO_E_PARAM_INVALID_CHANNEL_ID

#define DIO_E_PARAM_INVALID_CHANNEL_ID  (0x0AU)
#endif
/*
 * Design: MCAL-5441
 */
#ifndef DIO_E_PARAM_INVALID_PORT_ID

#define DIO_E_PARAM_INVALID_PORT_ID     (0x14U)
#endif
/*
 * Design: MCAL-5493
 */
#ifndef DIO_E_PARAM_INVALID_GROUP

#define DIO_E_PARAM_INVALID_GROUP       (0x1FU)
#endif
/*
 * Design: MCAL-5425
 */
#ifndef DIO_E_PARAM_POINTER

#define DIO_E_PARAM_POINTER             (0x20U)
#endif
/* @} */

/* DIO API service identification */
#define DIO_SID_READ_CHANNEL            (0U)

#define DIO_SID_WRITE_CHANNEL           (1U)

#define DIO_SID_READ_PORT               (2U)

#define DIO_SID_WRITE_PORT              (3U)

#define DIO_SID_READ_CHL_GROUP          (4U)

#define DIO_SID_WRITE_CHL_GROUP         (5U)

#define DIO_SID_FLIP_CHANNEL            (7U)

#define DIO_SID_GET_VERSION_INFO        (18U)
/* @} */

/*
 * Design: MCAL-5447
 */
#define DIO_PORT_WIDTH                  (32U)

#define DIO_MCAL_2139_FIXED             (0U)
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

/*
 * Design: MCAL-5503,MCAL-5436,MCAL-5446,MCAL-5449
 */
typedef uint32 Dio_ChannelType;

/*
 * Design: MCAL-5533,MCAL-5521,MCAL-5504,MCAL-5516
 */
typedef uint32 Dio_PortType;

/*
 * Design: MCAL-5486,MCAL-5484
 */
typedef uint32 Dio_PortLevelType;
/*
 * Design: MCAL-5484,MCAL-5526,MCAL-5518
 */
typedef struct
{
    Dio_PortType      port;
    Dio_PortLevelType mask;
    uint8             offset;
} Dio_ChannelGroupType;

/*
 * Design: MCAL-5519,MCAL-5517
 */
typedef uint8 Dio_LevelType;

/*
** \name Values used to configure the direction of GPIO pins.
* @{
*/
typedef enum {
    DIO_DIR_INPUT  = 0x1U,
    DIO_DIR_OUTPUT = 0x0U
} Dio_DirectionType;
/* @} */

#if (STD_ON == DIO_REGISTER_READBACK_API)
typedef struct
{
    /*
     * DIO related registers
     */
    uint32      pid;
    Dio_DirectionType Dio_Direction;
} Dio_RegisterReadbackType;
#endif  /* #if (STD_ON == DIO_REGISTER_READBACK_API) */



/* @} */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

FUNC(Dio_LevelType, DIO_CODE) Dio_ReadChannel(Dio_ChannelType ChannelId);

FUNC(void, DIO_CODE) Dio_WriteChannel(
    Dio_ChannelType ChannelId, Dio_LevelType Level);

FUNC(Dio_PortLevelType, DIO_CODE) Dio_ReadPort(Dio_PortType PortId);

FUNC(void, DIO_CODE) Dio_WritePort(
    Dio_PortType PortId, Dio_PortLevelType Level);

FUNC(Dio_PortLevelType, DIO_CODE) Dio_ReadChannelGroup(
    const Dio_ChannelGroupType *ChannelGroupIdPtr);

FUNC(void, DIO_CODE) Dio_WriteChannelGroup(
    const Dio_ChannelGroupType *ChannelGroupIdPtr, Dio_PortLevelType Level);

#if (STD_ON == DIO_VERSION_INFO_API)

FUNC(void, DIO_CODE) Dio_GetVersionInfo(
    P2VAR(Std_VersionInfoType, AUTOMATIC, DIO_APPL_DATA) versioninfo);
#endif

#if (STD_ON == DIO_FLIP_CHANNEL_API)

FUNC(Dio_LevelType, DIO_CODE) Dio_FlipChannel(Dio_ChannelType ChannelId);
#endif

#if (STD_ON == DIO_REGISTER_READBACK_API)

FUNC(Std_ReturnType, DIO_CODE) Dio_RegisterReadback(Dio_ChannelType ChannelId, Dio_RegisterReadbackType *DioRegRbPtr);
#endif

#ifdef __cplusplus
}
#endif

#endif  /* #ifndef DIO_H_ */

/* @} */