1 /*

     2   display_chipset_api_interfaces.h

     3 

     4   Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 

     5   All rights reserved.

     6 

     7   This program and the accompanying materials are made available 

     8   under the terms of the Eclipse Public License v1.0 which accompanies 

     9   this distribution, and is available at 

    10   http://www.eclipse.org/legal/epl-v10.html

    11 

    12   Initial Contributors:

    13   Nokia Corporation - initial contribution.

    14 

    15   Contributors:

    16 */

    17 

    18 /** @file

    19 

    20 Declaration of display chipset driver API interface storage

    21 

    22 @publishedDeviceAbstraction

    23 */

    24 

    25 #ifndef DISPLAY_CHIPSET_API_INTERFACES_H

    26 #define DISPLAY_CHIPSET_API_INTERFACES_H

    27 

    28 /*- Include Files  ----------------------------------------------------------*/

    29 

    30 #include "display_chipset_os.h"  /* OS specific header file, typedefs etc. */

    31 #include "display_chipset_api.h" /* Fetch enumeration etc */

    32 

    33 /*- Data Types --------------------------------------------------------------*/

    34 

    35 /*- Enumerations ------------------------------------------------------------*/

    36 

    37 /*- Data Structs ------------------------------------------------------------*/

    38 

    39 /*- Constants ---------------------------------------------------------------*/

    40 

    41 /*- Macros ------------------------------------------------------------------*/

    42 

    43 /*- External Data -----------------------------------------------------------*/

    44 

    45 /*- Variables ---------------------------------------------------------------*/

    46 

    47 /*- Forward Declarations ----------------------------------------------------*/

    48 

    49 /*- Functional Prototypes ---------------------------------------------------*/

    50 

    51 /** Chipset API interface registration method.

    52     @param  driverName  Unique name of component which will register to the Interface Storage

    53     @param  displayBus  Bus type what this interface controls

    54     @param  apiPointer  This chipset API interface pointer

    55     @return  DISP_ERROR_NONE if ok.

    56              DISP_ERROR_ALREADY_EXISTS if same name and bus is already registered. */

    57 DLL_IMPORT DISPE_ERROR dispSetInterface(CHIPSET_DRV_NAME driverName, DISPE_BUS displayBus, API_POINTER apiPointer);

    58 

    59 /** Chipset API interface getter.

    60     If got pointer is NULL or DISP_ERROR_NOT_FOUND is returned, caller has to try same query later.

    61     @param  callerName     Unique name of component which is getting the pointer to specific 'displayBus'

    62     @param  displayBus     Bus type what this interface controls

    63     @param  gotApiPointer  Pointer to API interface. This is filled for caller by interface storage.

    64     @return  DISP_ERROR_NONE if ok.

    65              DISP_ERROR_INVALID_NAME This name is not recognised

    66              DISP_ERROR_NOT_FOUND no any registered for this DISPE_BUS */

    67 DLL_IMPORT DISPE_ERROR dispGetInterface(CHIPSET_DRV_NAME callerName, DISPE_BUS displayBus, API_POINTER* gotApiPointer);

    68 

    69 /*- Inline Functions --------------------------------------------------------*/

    70 

    71 #endif /* DISPLAY_CHIPSET_API_INTERFACES_H */

    72 

    73 /* End of File */

    74