1 /*

     2 * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name        : startupadaptationevents.h

    16 * Part of     : System Startup / Starter

    17 * Interface   : Domain, Startup Adaptation API

    18 * This header file defines the startup adaptation API events

    19 * and their parameters.

    20 * This file contains the following sections:

    21 * - Event definitions

    22 * - Event parameter definitions

    23 * Version     : %version: 5 %

    24 * This material, including documentation and any related computer

    25 * programs, is protected by copyright controlled by Nokia.  All

    26 * rights are reserved.  Copying, including reproducing, storing,

    27 * adapting or translating, any or all of this material requires the

    28 * prior written consent of Nokia.  This material also contains

    29 * confidential information which may not be disclosed to others

    30 * without the prior written consent of Nokia.

    31 * Template version: 4.0

    32 * Nokia Core OS *

    33 *

    34 */

    35 

    36 

    37 

    38 #ifndef __STARTUPADAPTATIONEVENTS_H__

    39 #define __STARTUPADAPTATIONEVENTS_H__

    40 

    41 #include <e32cmn.h>

    42 /*

    43 * @file

    44 * @publishedPartner

    45 * @released

    46 */

    47 

    48 /*****************************************************

    49 *       Series 60 Customer

    50 *       Needs customer implementation

    51 *****************************************************/

    52 

    53 /**

    54 * All command and event definitions of Startup Adaptation API belong to

    55 * StartupAdaptation namespace.

    56 */

    57 namespace StartupAdaptation

    58     {

    59 

    60     // DATA TYPES

    61 

    62     /**

    63     * Event definitions.

    64     * All events contain an event id and a set of parameters. The event ids

    65     * are defined first and after that parameters for each event.

    66     *

    67     * The field @param means the parameter for the event.

    68     */

    69 

    70     /**

    71     * Events originated from Domestic OS.

    72     */

    73     enum TEvent

    74         {

    75         /**

    76         * In case a licensee-specific fatal error occurs, this event can be

    77         * used to report the error to S60 starter server.

    78         *

    79         * Events raised in ESWStateShuttingDown or ESWStateFatalStartupError

    80         * state are ignored.

    81         *

    82         * @param TFatalErrorTypePckg Identifies the reason of the error.

    83         */

    84         EFatalError = 100,

    85 

    86         /**

    87         * This event can be used to indicate to S60 starter server that a reset

    88         * is required. After receiving this event, S60 starter server will

    89         * start the normal reset sequence.

    90         */

    91         EDOSOriginatedReset,

    92 

    93         /**

    94         * This event can be used to indicate to S60 starter server that a

    95         * shutdown is required, for instance if battery level is very low.

    96         * After receiving this event, S60 starter server will start the normal

    97         * shutdown sequence.

    98         */

    99         EDOSOriginatedShutdown,

   100 

   101         /**

   102         * In case there is a change in the SIM cards state after the security

   103         * check phase, the state change should be reported to S60 starter

   104         * server using this event. Exception is total removal of the SIM card,

   105         * which is reported using the fatal error event.

   106         *

   107         * @param TSimEventTypePckg Identifies the event that has occurred.

   108         */

   109         ESimEvent

   110         };

   111 

   112     /**

   113     * Event parameter definitions.

   114     * Parameters for event are collected into a package buffer.

   115     */

   116 

   117     /**

   118     * The list of errors that may occur any time during or after startup.

   119     */

   120     enum TFatalErrorType

   121         {

   122         /**

   123         * The SIM card has been physically removed from the terminal

   124         * (unrecoverable situation).

   125         */

   126         ESimRemoved = 100,

   127         /**

   128         * Another unrecoverable error.

   129         */

   130         EUnclassifiedError

   131         };

   132 

   133     /**

   134     * Buffer descriptor containing TFatalErrorType object.

   135     */

   136     typedef TPckgBuf<TFatalErrorType> TFatalErrorTypePckg;

   137 

   138 

   139     /**

   140     * The list of SIM events that may occur after critical phase.

   141     */

   142     enum TSimEventType

   143         {

   144         /**

   145         * The SIM card is fully usable.

   146         */

   147         ESimUsable = 100,

   148         /**

   149         * The SIM card is not fully usable, but the emergency number can be

   150         * read.

   151         */

   152         ESimReadable,

   153         /**

   154         * The SIM card is disconnected, but still physically attached in the

   155         * terminal (recoverable situation).

   156         */

   157         ESimNotReady

   158         };

   159 

   160     /**

   161     * Buffer descriptor containing TSimEventType object.

   162     */

   163     typedef TPckgBuf<TSimEventType> TSimEventTypePckg;

   164 

   165     }

   166 

   167 #endif // __STARTUPADAPTATIONEVENTS_H__