build: Whitespace & keep vim happy
[platform/upstream/ofono.git] / doc / emergency-call-handling.txt
1 This document explains what is expected from applications and what oFono
2 will do for an emergency call request in different states.
3
4 Case 1: Call in offline and SIM present state
5
6 Expected from UI/applications:
7
8         - Online property of org.ofono.Modem interface should be set to TRUE.
9         - Dial method should be called with the dialled number.
10
11 What oFono will do:
12
13         - Modem will be set to online.
14         - Post online atoms will be created.
15         - Upon reception of Dial request, Emergency mode is activated.
16         - Once the call is ended, Emergency mode is deactivated.
17         - Modem remains in online mode with full funcationality.
18
19 Case 2: Call in SIM Present and PIN required state
20
21 Expected from UI/applications:
22
23         - If the user enters emergency number in the PIN entry dialog, then
24           Online property on org.ofono.Modem interface should be set to TRUE.
25                 - List of Emergency numbers can be known from the
26                   EmergencyNumbers property on the org.ofono.VoiceCallManager
27                   interface.
28         - Dial method should be called with the dialled number
29
30 What oFono will do:
31
32         - Modem will be set to online.
33         - Upon reception of Dial request, Emergency mode is activated.
34         - Once the call is ended, Emergency mode is deactivated.
35         - Modem remains in online mode but the functionalities will be
36           limited.
37
38 Case 3: Call in SIM Present and PIN required state - Dial cancelled by user
39
40 Expected from UI/applications:
41
42         - If the user enters emergency number in the PIN entry dialog, then
43           Online property on org.ofono.Modem interface should be set to TRUE.
44                 - List of Emergency numbers can be known from the
45                   EmergencyNumbers property on the org.ofono.VoiceCallManager
46                   interface.
47         - Dial method should be called with the dialled number
48         - Upon dial cancellation by user, HangupAll should be called.
49
50 What oFono will do:
51
52         - Modem will be set to online.
53         - Post SIM and Post online atoms are not created.
54         - Upon reception of Dial request, Emergency mode is activated.
55         - Upon dial cancellation(HangupAll request), Emergency mode is
56           deactivated.
57         - Modem remains in online mode but the functionalities will be
58           limited.
59
60 Case 4: Call in No SIM state
61
62 Expected from UI/applications:
63
64         - Online property on org.ofono.Modem interface should be set to TRUE.
65         - Dial method should be called with the dialled number
66
67 What oFono will do:
68
69         - Modem will be set to online.
70         - Post SIM and Post online atoms not created.
71         - If the dialed number is an Emergeny number, Emergency mode is
72           activated.
73         - Once the call is ended, Emergency mode is deactivated.
74         - Modem remains in online mode but the functionalities will be
75           limited.
76
77 Case 5: Call in No SIM state - PIN disabled SIM inserted during emergency call
78
79 Expected from UI/applications:
80
81         - Online property on org.ofono.Modem interface should be set to TRUE.
82         - Dial method should be called with the dialled number
83
84 What oFono will do:
85
86         - Modem will be set to online.
87         - Post SIM and Post online atoms are not created.
88         - If the dialed number is an Emergeny number, Emergency mode is
89           activated.
90         - Upon PIN disabled SIM detection, Post SIM and Post online
91           atoms are created.
92         - Once the call is ended, Emergency mode is deactivated.
93         - Modem remains in online mode with full functionality.
94
95 Case 6: Call in No SIM state - PIN enabled SIM inserted during emergency call
96
97 Expected from UI/applications:
98
99         - Online property on org.ofono.Modem interface should be set to TRUE.
100         - Dial method should be called with the dialled number
101
102 What oFono will do:
103
104         - Modem will be set to online.
105         - Post SIM and Post online atoms are not created.
106         - If the dialed number is an Emergeny number, Emergency mode is
107           activated.
108         - Upon PIN enabled SIM detection, applications will be informed
109           of the pin status via PinRequired property on the
110           org.ofono.SimManager interface.
111         - Once the call is ended, Emergency mode is deactivated.
112         - Modem remains in online mode but the functionalities will be
113           limited.