ODeV framework  v2
Data Structures | Typedefs | Functions
PushButtonTask.h File Reference

Handle the Push Button of the NUCLEO board. More...

#include "systp.h"
#include "syserror.h"
#include "AManagedTaskEx.h"
#include "AManagedTaskEx_vtbl.h"
#include "IDriver.h"
#include "IDriverVtbl.h"
+ Include dependency graph for PushButtonTask.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _PushButtonTask
 

Typedefs

typedef struct _PushButtonTask PushButtonTask
 

Functions

AManagedTaskExPushButtonTaskAlloc ()
 
sys_error_code_t PushButtonTaskSetDriver (PushButtonTask *this, IDriver *pDxriver)
 

Detailed Description

Handle the Push Button of the NUCLEO board.

Author
STMicroelectronics - ST-Korea - MCD Team
Version
1.0.0
Date
Nov 5, 2018

This managed task is responsible to handle the user button and to generate the SysEvent in order to trigger the power mode transactions.

Attention

© COPYRIGHT 2017 STMicroelectronics

Licensed under MCD-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at:

   http://www.st.com/software_license_agreement_liberty_v2

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

◆ PushButtonTask

Create type name for _PushButtonTask.

Function Documentation

◆ PushButtonTaskAlloc()

AManagedTaskEx* PushButtonTaskAlloc ( )

Allocate an instance of PushButtonTask.

Returns
a pointer to the generic object AManagedTaskEx if success, or NULL if out of memory error occurs.

◆ PushButtonTaskSetDriver()

SYS_DEFINE_INLINE sys_error_code_t PushButtonTaskSetDriver ( PushButtonTask this,
IDriver pDxriver 
)
inline

Set the driver used by task to use the push button.

Parameters
this[IN] specifies a pointer to a task object.
pDxriver[IN] specifies a pointer to a driver of type ::NuceloDriver.
Returns
SYS_NO_ERROR_CODE.