key.h

00001 /*******************************************************************************
00002 * DISCLAIMER
00003 * This software is supplied by Renesas Electronics Corporation and is only
00004 * intended for use with Renesas products. No other uses are authorized. This
00005 * software is owned by Renesas Electronics Corporation and is protected under
00006 * all applicable laws, including copyright laws.
00007 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
00008 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
00009 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
00010 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
00011 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
00012 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
00013 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
00014 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
00015 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00016 * Renesas reserves the right, without notice, to make changes to this software
00017 * and to discontinue the availability of this software. By using this software,
00018 * you agree to the additional terms and conditions found by accessing the
00019 * following link:
00020 * http://www.renesas.com/disclaimer*
00021 * Copyright (C) 2015 Renesas Electronics Corporation. All rights reserved.
00022 *******************************************************************************/
00023 
00024 #ifndef KEY_H
00025 #define KEY_H
00026 
00027 /*--- Macro definition ---*/
00028 #define KEY_STACK_SIZE     (2048u)      /* Stack size of key thread */
00029 
00030 /** Key Thread
00031  *
00032  *  @param argument Pointer to the thread function as start argument.
00033  */
00034 void key_thread(void const *argument);
00035 
00036 /** Notifies the key thread of the display mode.
00037  *
00038  *  @param disp_mode display mode
00039  *
00040  *  @returns 
00041  *    Returns true if the API is successful. Returns false if the API fails.
00042  *    This function fails when:
00043  *     Failed to secure memory for mailbox communication.
00044  *     Failed to perform transmit processing for mailbox communication.
00045  */
00046 bool key_notify_disp_mode(const uint32_t disp_mode);
00047 
00048 #endif /* KEY_H */