blob: 1b989326e25ba59c192c94ff553d3ee8b29f9cb4 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/*
* Copyright (c) 2015, Freescale Semiconductor, Inc.
* Copyright 2016-2022 NXP
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef __FSL_LPI2C_FREERTOS_H__
#define __FSL_LPI2C_FREERTOS_H__
#include "FreeRTOS.h"
#include "portable.h"
#include "semphr.h"
#include "fsl_lpi2c.h"
/*!
* @addtogroup lpi2c_freertos_driver LPI2C FreeRTOS Driver
* @{
*/
/*******************************************************************************
* Definitions
******************************************************************************/
/*! @name Driver version */
/*@{*/
/*! @brief LPI2C FreeRTOS driver version. */
#define FSL_LPI2C_FREERTOS_DRIVER_VERSION (MAKE_VERSION(2, 3, 2))
/*@}*/
/*!
* @cond RTOS_PRIVATE
* @brief LPI2C FreeRTOS handle
*/
typedef struct _lpi2c_rtos_handle
{
LPI2C_Type *base; /*!< LPI2C base address */
lpi2c_master_handle_t drv_handle; /*!< Handle of the underlying driver, treated as opaque by the RTOS layer */
status_t async_status;
SemaphoreHandle_t mutex; /*!< Mutex to lock the handle during a trasfer */
SemaphoreHandle_t semaphore; /*!< Semaphore to notify and unblock task when transfer ends */
} lpi2c_rtos_handle_t;
/*! \endcond */
/*******************************************************************************
* API
******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
/*!
* @name LPI2C RTOS Operation
* @{
*/
/*!
* @brief Initializes LPI2C.
*
* This function initializes the LPI2C module and related RTOS context.
*
* @param handle The RTOS LPI2C handle, the pointer to an allocated space for RTOS context.
* @param base The pointer base address of the LPI2C instance to initialize.
* @param masterConfig Configuration structure to set-up LPI2C in master mode.
* @param srcClock_Hz Frequency of input clock of the LPI2C module.
* @return status of the operation.
*/
status_t LPI2C_RTOS_Init(lpi2c_rtos_handle_t *handle,
LPI2C_Type *base,
const lpi2c_master_config_t *masterConfig,
uint32_t srcClock_Hz);
/*!
* @brief Deinitializes the LPI2C.
*
* This function deinitializes the LPI2C module and related RTOS context.
*
* @param handle The RTOS LPI2C handle.
*/
status_t LPI2C_RTOS_Deinit(lpi2c_rtos_handle_t *handle);
/*!
* @brief Performs I2C transfer.
*
* This function performs an I2C transfer using LPI2C module according to data given in the transfer structure.
*
* @param handle The RTOS LPI2C handle.
* @param transfer Structure specifying the transfer parameters.
* @return status of the operation.
*/
status_t LPI2C_RTOS_Transfer(lpi2c_rtos_handle_t *handle, lpi2c_master_transfer_t *transfer);
/*!
* @}
*/
#if defined(__cplusplus)
}
#endif
/*!
* @}
*/
#endif /* __FSL_LPI2C_FREERTOS_H__ */
|
