12 <concept id="GUID-B386CA7A-F527-5584-9455-371E623DCF76" xml:lang="en"><title> System

    12 <concept id="GUID-B386CA7A-F527-5584-9455-371E623DCF76" xml:lang="en"><title> System Start Example</title><prolog><metadata><keywords/></metadata></prolog><conbody>

    13 Start Example</title><prolog><metadata><keywords/></metadata></prolog><conbody>

    13 <section id="GUID-1B233701-DF98-46DD-A9F0-1DBBBD8F07E3"><title>Download</title> <p>Click on the following link to

    14 <section><title>Download</title> <p>Click on the following link to download

    14 download the example: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/zips/guid-e4fe3134-4d3b-443f-80fe-374972df6f9b.zip" scope="external"> SysStart.zip</xref></p><p>Click: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/guid-e4fe3134-4d3b-443f-80fe-374972df6f9b.html" scope="peer">browse</xref> to view the example code. </p> </section>

    15 the example: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/zips/guid-e4fe3134-4d3b-443f-80fe-374972df6f9b.zip" scope="external"> SysStart.zip</xref></p><p>Click: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/guid-e4fe3134-4d3b-443f-80fe-374972df6f9b.html" scope="peer">browse</xref> to view the example code. </p> </section>

    15 <section id="GUID-F3EFB022-A771-50D2-9C36-FFEFA4924441"><title> Description</title> <p>This example demonstrates the use of resource files at the time

    16 <section id="GUID-F3EFB022-A771-50D2-9C36-FFEFA4924441"><title> Description</title> <p>This

    16 of System Start-up. System starter is an architecture designed to

    17 example demonstrates the use of resource files at the time of System Start-up.

    17 provide a consistent, transparent, easily customisable method of starting

    18 System starter is an architecture designed to provide a consistent, transparent,

    18 components (i.e. servers and applications) at device boot. It allows

    19 easily customisable method of starting components (i.e. servers and applications)

    19 an ordering of components according to criticality and dependency

    20 at device boot. It allows an ordering of components according to criticality

    20 by means of a Static Start-up Configuration (SSC). </p> </section>

    21 and dependency by means of a Static Start-up Configuration (SSC). </p> </section>

    21 <section id="GUID-9C5B0C4B-32F9-4F39-8C3E-F5188A6D54AA"><title>Related APIs</title><ul>

    22 <section><title>Related APIs</title><p><xref href="GUID-478D0251-D49B-36C5-B9DF-09FFFE7CDB53.dita#GUID-478D0251-D49B-36C5-B9DF-09FFFE7CDB53/GUID-E99F5505-FC87-3232-A933-4C522C04931A"><apiname>egSysStart::E32Main () </apiname></xref></p><p><xref href="GUID-478D0251-D49B-36C5-B9DF-09FFFE7CDB53.dita#GUID-478D0251-D49B-36C5-B9DF-09FFFE7CDB53/GUID-54F036C5-D86E-34B0-B74A-AD4DF2328086"><apiname>egSysStart::Simple

    22 <li><p><codeph>egSysStart::E32Main ()</codeph></p></li>

    23 ()</apiname></xref></p></section>

    23 <li><p><codeph>egSysStart::Simple ()</codeph></p></li>

    24 <section id="GUID-693F8259-B441-50F2-8E2A-EB2A57E5665A"><title>Resource files</title> <p>In

    24 </ul></section>

    25 this example a resource file <codeph>SSCForStartupMode0.rss</codeph> is used

    25 <section id="GUID-693F8259-B441-50F2-8E2A-EB2A57E5665A"><title>Resource

    26 at Start-up. </p> <p>On a target device booting normally, the SSC <codeph>SSCForStartupMode0.rss</codeph> is

    26 files</title> <p>In this example a resource file <codeph>SSCForStartupMode0.rss</codeph> is used at Start-up. </p> <p>On a target device booting normally,

    27 always used for start-up. This SSC is associated with startup mode zero, which

    27 the SSC <codeph>SSCForStartupMode0.rss</codeph> is always used for

    28 is defined as <xref href="GUID-6866563D-8AF5-3F3F-A777-50B264194B83.dita"><apiname>EStartupModeUndefined</apiname></xref> in e32modes.h. The

    28 start-up. This SSC is associated with startup mode zero, which is

    29 System Starter architecture provides an ability to select between a number

    29 defined as <xref href="GUID-6866563D-8AF5-3F3F-A777-50B264194B83.dita"><apiname>EStartupModeUndefined</apiname></xref> in e32modes.h.

    30 of static Start-up configurations (rss files) depending on the desired Start-up

    30 The System Starter architecture provides an ability to select between

    31 Mode, for example: Full, Emergency, Charging, or Test. Each of these modes

    31 a number of static Start-up configurations (rss files) depending on

    32 may require different sets of components and order of execution. </p> <p>The

    32 the desired Start-up Mode, for example: Full, Emergency, Charging,

    33 start-up process in the resource file is staged via an ordering of Start-up

    33 or Test. Each of these modes may require different sets of components

    34 States or phases. These states cannot be removed or their values altered.

    34 and order of execution. </p> <p>The start-up process in the resource

    35 They appear in the following order: </p> <p> <xref href="GUID-F4C1F118-3580-3D25-AB14-DAD8D20CF302.dita"><apiname>EStartupStateUndefined</apiname></xref> –

    35 file is staged via an ordering of Start-up States or phases. These

    36 Value before the system enters its first state/ undefined state. </p> <p> <xref href="GUID-DA625784-61CA-3256-9D93-EB447BF9AA62.dita"><apiname>EStartupStateCriticalStatic</apiname></xref> –

    36 states cannot be removed or their values altered. They appear in the

    37 Within this Start-up State all ROM based (static) components or resources

    37 following order: </p> <p> <xref href="GUID-D3303938-1F27-319A-836A-FE4242E91696.dita#GUID-D3303938-1F27-319A-836A-FE4242E91696/GUID-96874644-A26A-36E6-AFE4-568B2DA8C2E5"><apiname>TStartupCommandType::EStartupStateUndefined</apiname></xref> – Value before the system enters its first state/ undefined state. </p> <p> <xref href="GUID-D3303938-1F27-319A-836A-FE4242E91696.dita#GUID-D3303938-1F27-319A-836A-FE4242E91696/GUID-1FF1DBF6-7AB1-33E0-8D10-AADE02B7D440"><apiname>TStartupCommandType::EStartupStateCriticalStatic</apiname></xref> – Within this Start-up State all ROM based (static) components or

    38 that are critical to the operation of the phone function are started. </p> <p> <xref href="GUID-737BC60E-ECA2-3B22-A0A4-5F6F5136D6F0.dita"><apiname>EStartupStateCriticalDynamic</apiname></xref> –

    38 resources that are critical to the operation of the phone function

    39 Within this Start-up State all non-ROM based (dynamic) components or resources

    39 are started. </p> <p> <xref href="GUID-D3303938-1F27-319A-836A-FE4242E91696.dita#GUID-D3303938-1F27-319A-836A-FE4242E91696/GUID-A5FB6340-2EA8-32A3-8138-95DD326BC123"><apiname>TStartupCommandType::EStartupStateCriticalDynamic</apiname></xref> – Within this Start-up State all non-ROM based (dynamic) components

    40 that are critical to the operation of the phone function are started. </p> <p> <xref href="GUID-3C0E080D-7FF1-3347-B129-D2805FCD7840.dita"><apiname>EStartupStateNonCritical</apiname></xref> –

    40 or resources that are critical to the operation of the phone function

    41 Within this Start-up State all ROM based (static) or non-ROM based (dynamic)

    41 are started. </p> <p> <xref href="GUID-D3303938-1F27-319A-836A-FE4242E91696.dita#GUID-D3303938-1F27-319A-836A-FE4242E91696/GUID-5883EFE6-36A6-30EB-851B-9FD26C1C9B03"><apiname>TStartupCommandType::EStartupStateNonCritical</apiname></xref> – Within this Start-up State all ROM based (static) or non-ROM based

    42 components or resources that are non-critical to the operation of the phone

    42 (dynamic) components or resources that are non-critical to the operation

    43 function are started. All components that have not already been started and

    43 of the phone function are started. All components that have not already

    44 are required at device boot are started in this Start-up State. </p> <p>This

    44 been started and are required at device boot are started in this Start-up

    45 allows start-up to be split into separate, distinct states with a defined

    45 State. </p> <p>This allows start-up to be split into separate, distinct

    46 order. Within each state, a <codeph>STATE_INFO</codeph> structure containing

    46 states with a defined order. Within each state, a <codeph>STATE_INFO</codeph> structure containing information regarding that state is located.

    47 information regarding that state is located. This contains the following information: </p> <table id="GUID-A370B739-910B-55E5-9C92-FAC72362FDCB">

    47 This contains the following information: </p> <table id="GUID-A370B739-910B-55E5-9C92-FAC72362FDCB">

    60 <entry><p>The name of the Command array in the SSC which contains the list

    60 <entry><p>The name of the Command array in the SSC which contains

    61 of Commands to invoke in that state </p> </entry>

    61 the list of Commands to invoke in that state </p> </entry>

    65 <entry><p>The name of the Command array corresponding to the next state </p> </entry>

    65 <entry><p>The name of the Command array corresponding to the next

    66 state </p> </entry>

    69 </table> <p>Following the <codeph>STATE_INFO</codeph> structure in the SSC

    70 </table> <p>Following the <codeph>STATE_INFO</codeph> structure in

    70 is a <codeph>COMMAND_ARRAY</codeph> structure. This contains details of all

    71 the SSC is a <codeph>COMMAND_ARRAY</codeph> structure. This contains

    71 commands to be executed within that list. Its name matches the command_list

    72 details of all commands to be executed within that list. Its name

    72 identifier in the <codeph>STATE_INFO</codeph> struct and contains one array

    73 matches the command_list identifier in the <codeph>STATE_INFO</codeph> struct and contains one array entry: Commands. The Command entry

    73 entry: Commands. The Command entry contains a list of all commands to be executed.

    74 contains a list of all commands to be executed. Each instance in the

    74 Each instance in the rss file is headed with the <codeph>START_PROCESS_INFO </codeph> identifier

    75 rss file is headed with the <codeph>START_PROCESS_INFO </codeph> identifier

    92 <entry><p>The enum <codeph>TStartupCommandType</codeph> is defined in <codeph>startup.hrh</codeph>.

    93 <entry><p>The enum <codeph>TStartupCommandType</codeph> is defined

    93 Currently it takes one of three values: </p> <ul>

    94 in <codeph>startup.hrh</codeph>. Currently it takes one of three values: </p> <ul>

    94 <li id="GUID-EB15D58C-A9FC-5C92-A5F6-23CA7D547C86"><p> <xref href="GUID-119A71D6-F979-345B-8AC7-7768F68A36BE.dita"><apiname>EFireAndForget</apiname></xref> (the

    95 <li id="GUID-EB15D58C-A9FC-5C92-A5F6-23CA7D547C86"><p> <xref href="GUID-119A71D6-F979-345B-8AC7-7768F68A36BE.dita"><apiname>EFireAndForget</apiname></xref> (the default) </p> </li>

    95 default) </p> </li>

    98 </ul> <p>Use <xref href="GUID-119A71D6-F979-345B-8AC7-7768F68A36BE.dita"><apiname>EFireAndForget</apiname></xref> if there is no need for the

    98 </ul> <p>Use <xref href="GUID-119A71D6-F979-345B-8AC7-7768F68A36BE.dita"><apiname>EFireAndForget</apiname></xref> if there is no need

    99 process to be started serially in other words as soon as the process has been

    99 for the process to be started serially in other words as soon as the

   100 invoked, the System Starter can continue with starting the next process without

   100 process has been invoked, the System Starter can continue with starting

   101 waiting for the process to rendezvous. </p> <p>Use <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> if

   101 the next process without waiting for the process to rendezvous. </p> <p>Use <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> if the process needs to

   102 the process needs to get to a certain stage before starting the next process.

   102 get to a certain stage before starting the next process. The starter

   103 The starter cannot continue with the next Command until a rendezvous has been

   103 cannot continue with the next Command until a rendezvous has been

   104 made with the first process. </p> <p>Note that the apparc component must be

   104 made with the first process. </p> <p>Note that the apparc component

   105 started with mode <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> to allow connection with

   105 must be started with mode <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> to allow

   106 the server to take place. </p> <p>Use <xref href="GUID-3C5930DE-E84C-3170-AC5A-BCFC16D6AE77.dita"><apiname>EDeferredWaitForStart</apiname></xref> if

   106 connection with the server to take place. </p> <p>Use <xref href="GUID-3C5930DE-E84C-3170-AC5A-BCFC16D6AE77.dita"><apiname>EDeferredWaitForStart</apiname></xref> if there is no need to start the process serially, but at a later

   107 there is no need to start the process serially, but at a later stage there

   107 stage there is a command which cannot be invoked until this process

   108 is a command which cannot be invoked until this process has initialized. Using

   108 has initialized. Using this value allows a number of commands to be

   109 this value allows a number of commands to be started and the System Starter

   109 started and the System Starter to wait for them all at a later point

   110 to wait for them all at a later point in the SSC. This ensures later on that

   110 in the SSC. This ensures later on that the initializations of all <xref href="GUID-3C5930DE-E84C-3170-AC5A-BCFC16D6AE77.dita"><apiname>EDeferredWaitForStart</apiname></xref> commands have completed. </p> <p> <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> and <xref href="GUID-3C5930DE-E84C-3170-AC5A-BCFC16D6AE77.dita"><apiname>EDeferredWaitForStart</apiname></xref> depend upon receiving a rendezvous from the started process. By

   111 the initializations of all <xref href="GUID-3C5930DE-E84C-3170-AC5A-BCFC16D6AE77.dita"><apiname>EDeferredWaitForStart</apiname></xref> commands

   111 default this is performed automatically by EikonEnv. If however, you

   112 have completed. </p> <p> <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> and <xref href="GUID-3C5930DE-E84C-3170-AC5A-BCFC16D6AE77.dita"><apiname>EDeferredWaitForStart</apiname></xref> depend

   112 wish your component to perform its own rendezvous, then the following

   113 upon receiving a rendezvous from the started process. By default this is performed

   113 function should be overridden in your AppUi class and return <codeph>EFalse.</codeph>  </p> <p> <codeph>TBool CCoeAppUi::FrameworkCallsRendezvous();</codeph>  </p> </entry>

   114 automatically by EikonEnv. If however, you wish your component to perform

   115 its own rendezvous, then the following function should be overridden in your

   116 AppUi class and return <codeph>EFalse.</codeph>  </p> <p> <codeph>TBool CCoeAppUi::FrameworkCallsRendezvous();</codeph>  </p> </entry>

   120 <entry><p>This field is for use with start_method <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> only. </p> <p>Indicate

   117 <entry><p>This field is for use with start_method <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> only. </p> <p>Indicate if a timer should be started when attempting

   121 if a timer should be started when attempting to start the process by filling

   118 to start the process by filling in this timeout value in milliseconds.

   122 in this timeout value in milliseconds. The value is 0 by default indicating

   119 The value is 0 by default indicating that no timer will be started. </p> <p>Note that if the timer expires before a rendezvous with the component

   123 that no timer will be started. </p> <p>Note that if the timer expires before

   120 is made, the component will be killed. If the component is a critical

   124 a rendezvous with the component is made, the component will be killed. If

   121 process this will result in a Kern:4 Panic (which on licensee phones

   125 the component is a critical process this will result in a Kern:4 Panic (which

   122 usually initiates in a system restart). </p> </entry>

   126 on licensee phones usually initiates in a system restart). </p> </entry>

   130 <entry><p>This specifies the action to take if an error is returned from an

   126 <entry><p>This specifies the action to take if an error is returned

   131 attempt to start the process. </p> <p>It is set to <xref href="GUID-644CC7B0-3B94-307A-A5A1-D7EC78F10105.dita"><apiname>ERestartOS</apiname></xref> by

   127 from an attempt to start the process. </p> <p>It is set to <xref href="GUID-644CC7B0-3B94-307A-A5A1-D7EC78F10105.dita"><apiname>ERestartOS</apiname></xref> by default. This means if the process fails

   132 default. This means if the process fails to start the system will restart

   128 to start the system will restart in the default start-up mode. </p> <p>If it is set to <xref href="GUID-1E757E7A-98C8-3455-8D82-28A24FBEA729.dita"><apiname>EIgnoreOnFailure</apiname></xref> then the

   133 in the default start-up mode. </p> <p>If it is set to <xref href="GUID-1E757E7A-98C8-3455-8D82-28A24FBEA729.dita"><apiname>EIgnoreOnFailure</apiname></xref> then

   129 starter will continue with the next Command. This option is intended

   134 the starter will continue with the next Command. This option is intended for

   130 for non-critical components on which nothing critical is dependent. </p> <p>If it is set to <xref href="GUID-D7BCDD4C-97A0-3068-AC4C-F10DA31DD636.dita"><apiname>ERestartOSWithMode</apiname></xref> the system

   135 non-critical components on which nothing critical is dependent. </p> <p>If

   131 will be restarted in a specific start-up mode. </p> <p>Note: this

   136 it is set to <xref href="GUID-D7BCDD4C-97A0-3068-AC4C-F10DA31DD636.dita"><apiname>ERestartOSWithMode</apiname></xref> the system will be restarted

   132 field has a slightly different use depending on the start mode: in

   137 in a specific start-up mode. </p> <p>Note: this field has a slightly different

   133 modes <xref href="GUID-119A71D6-F979-345B-8AC7-7768F68A36BE.dita"><apiname>EFireAndForget</apiname></xref> and <xref href="GUID-3C5930DE-E84C-3170-AC5A-BCFC16D6AE77.dita"><apiname>EDeferredWaitForStart</apiname></xref> a failure will be indicated only if there is an immediate error

   138 use depending on the start mode: in modes <xref href="GUID-119A71D6-F979-345B-8AC7-7768F68A36BE.dita"><apiname>EFireAndForget</apiname></xref> and <xref href="GUID-3C5930DE-E84C-3170-AC5A-BCFC16D6AE77.dita"><apiname>EDeferredWaitForStart</apiname></xref> a

   134 for example the initial process creation/invocation fails. In <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> a failure will also be indicated if there

   139 failure will be indicated only if there is an immediate error for example

   135 is no successful rendezvous. </p> </entry>

   140 the initial process creation/invocation fails. In <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> a

   141 failure will also be indicated if there is no successful rendezvous. </p> </entry>

   145 <entry><p>For use with start_method <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> only.

   139 <entry><p>For use with start_method <xref href="GUID-8415D00B-79D9-36BE-9F0B-2DAA3A553CD2.dita"><apiname>EWaitForStart</apiname></xref> only. Set to 0 by default. </p> <p>This specifies the maximum number

   146 Set to 0 by default. </p> <p>This specifies the maximum number of times the

   140 of times the starter should try to start a failed process. After the

   147 starter should try to start a failed process. After the process has been retried

   141 process has been retried the specified number of times, the starter

   148 the specified number of times, the starter will act according to the value

   142 will act according to the value in the <codeph>retry_failure_recovery_method</codeph> field. This is used in conjunction with the timeout value. </p> </entry>

   149 in the <codeph>retry_failure_recovery_method</codeph> field. This is used

   150 in conjunction with the timeout value. </p> </entry>

   154 <entry><p>Indicates whether the started process should be monitored for failure

   146 <entry><p>Indicates whether the started process should be monitored

   155 by the System Monitor component. The value is 0 by default indicating that

   147 for failure by the System Monitor component. The value is 0 by default

   156 no monitoring will be done. </p> <p>A value of 1 indicates monitoring should

   148 indicating that no monitoring will be done. </p> <p>A value of 1 indicates

   157 be performed. The recovery policy set by <codeph>retry_failure_recovery_method</codeph> (and

   149 monitoring should be performed. The recovery policy set by <codeph>retry_failure_recovery_method</codeph> (and if applicable retry_failure_recovery_startup_mode)

   158 if applicable retry_failure_recovery_startup_mode) will be used by the System

   150 will be used by the System Monitor if a failure occurs to this process

   159 Monitor if a failure occurs to this process during the lifetime of the system. </p> <p>Note:

   151 during the lifetime of the system. </p> <p>Note: if the component

   160 if the component being started is a System Critical process, monitoring must

   152 being started is a System Critical process, monitoring must not be

   161 not be enabled. </p> </entry>

   153 enabled. </p> </entry>

   165 <entry><p>For use with retry_failure_recovery_method <xref href="GUID-D7BCDD4C-97A0-3068-AC4C-F10DA31DD636.dita"><apiname>ERestartOSWithMode</apiname></xref> only. </p> <p>Used

   157 <entry><p>For use with retry_failure_recovery_method <xref href="GUID-D7BCDD4C-97A0-3068-AC4C-F10DA31DD636.dita"><apiname>ERestartOSWithMode</apiname></xref> only. </p> <p>Used to specify the start-up mode the system should

   166 to specify the start-up mode the system should restart with. This is set to <xref href="GUID-6866563D-8AF5-3F3F-A777-50B264194B83.dita"><apiname>EStartupModeUndefined</apiname></xref> by

   158 restart with. This is set to <xref href="GUID-6866563D-8AF5-3F3F-A777-50B264194B83.dita"><apiname>EStartupModeUndefined</apiname></xref> by default. </p> </entry>

   167 default. </p> </entry>