MPLAB® Harmony Graphics Suite  GFX v3.13.0
Legato API Documentation
legato_rtos.h
Go to the documentation of this file.
1 // DOM-IGNORE-BEGIN
2 /*******************************************************************************
3 * Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
4 *
5 * Subject to your compliance with these terms, you may use Microchip software
6 * and any derivatives exclusively with Microchip products. It is your
7 * responsibility to comply with third party license terms applicable to your
8 * use of third party software (including open source software) that may
9 * accompany Microchip software.
10 *
11 * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
12 * EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
13 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
14 * PARTICULAR PURPOSE.
15 *
16 * IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
17 * INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
18 * WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
19 * BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
20 * FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
21 * ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
22 * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
23 *******************************************************************************/
24 // DOM-IGNORE-END
25 
26 /*******************************************************************************
27  Module for Microchip Graphics Library
28 
29  Company:
30  Microchip Technology Inc.
31 
32  File Name:
33  libaria_rtos.h
34 
35  Summary:
36  This header file contains prototypes of the RTOS extensions of the aria
37  library top level APIs.
38 
39  Description:
40  This header file contains prototypes of the RTOS extensions of the aria
41  library top level APIs.
42 *******************************************************************************/
43 
44 
45 // *****************************************************************************
46 /* Type:
47  void laUpdate_RTOS()
48 
49  Summary:
50  RTOS version of the Legato library update (tasks) function.
51 
52  Description:
53  This function updates the active Aria library context state. It performs
54  event processing as well as servicing of the widget paint loop.
55 
56  This function may block to wait for events to process. Setting fullBlock = LA_TRUE
57  will fully block without timeout, otherwise it won't block.
58 
59  Parameters:
60  None
61 
62 */
63 
71 void laUpdate_RTOS(laBool fullBlock, uint32_t dt);
72