B2G/RIL: Difference between revisions

Jump to navigation Jump to search

B2G/RIL (view source)

Revision as of 22:22, 3 November 2011

2,783 bytes removed ,  3 November 2011
no edit summary
No edit summary
No edit summary
Line 1: Line 1:
= B2G RIL  =
= B2G RIL  =


This page contains information about B2G's interaction with the Radio Interface Layer of Android. The RIL provides access to the radio hardware, which is needed to send/receive calls, SMS&nbsp;messages, and other things that require interaction with a cell network.<br>
This page contains information about B2G's interaction with the Radio Interface Layer of Android. The RIL provides access to the radio hardware, which is needed to send/receive calls, SMS messages, and other things that require interaction with a cell network.


<br>
= Talking to the Radio =


* B2G Dialer Test
== Low Level Access ==
** Description
 
This program demonstrates how to communicate with the B2G RIL daemon,
for dialing the phone, dealing with SMS, and other actions requiring
access to the cell phone radio.
 
** Goals
 
- Create patch to make android radio core not connect to rild socket
- Figure out/find documentation for commands for ril events
- Create function that will dial phone via socket calls
- Create function that will wait for an SMS message (async) via sockets
 
* Talking to the Radio
** Low Level Access


Kernel access for specific phones are vendor specific, included in the
Kernel access for specific phones are vendor specific, included in the
Line 27: Line 12:
architecture is available at
architecture is available at


[[http://www.netmite.com/android/mydroid/development/pdk/docs/telephony.html]]
[http://www.netmite.com/android/mydroid/development/pdk/docs/telephony.html]


Source code for libril and rild is available in the B2G checkout as
Source code for libril and rild is available in the B2G checkout as
Line 33: Line 18:
glue/gonk/hardware/ril
glue/gonk/hardware/ril


** Socket Access
== Socket Access ==


In order to access libril, android uses an ipc socket interface to the
In order to access libril, android uses an ipc socket interface to the
Line 53: Line 38:
rild).  
rild).  


** Android Access
== Android Access ==
 
Android code specific to RIL communication is in  
Android code specific to RIL communication is in  


Line 65: Line 51:
To access sockets via C, android uses libcutils, also available in
To access sockets via C, android uses libcutils, also available in
glue/gonk/frameworks.
glue/gonk/frameworks.
** Parcel Formats
 
== Parcel Formats ==
 
Parcels contain information about the transaction that they are a part
Parcels contain information about the transaction that they are a part
of, as well as event data.
of, as well as event data.
Line 71: Line 59:
Event data will be one of the follow types:
Event data will be one of the follow types:


- Void - No return
* Void * No return
- Int List - First int is the number of ints in the list, followed by the ints
* Int List * First int is the number of ints in the list, followed by the ints
  - Byte 0x0c - uint32_t - number of ints in the packet
** Byte 0x0c - uint32_t - number of ints in the packet
  - Byte 0x10 - uint32_t* - list of ints
** Byte 0x10 - uint32_t- - list of ints
- String - A single string (16-bit)
* String - A single string (16-bit)
  - Byte 0x0c - uint32_t - length of string
** Byte 0x0c - uint32_t - length of string
  - Byte 0x10 - wchar_t* - string of length specified
** Byte 0x10 - wchar_t- - string of length specified
- Strings - An array of strings (16-bit)
* Strings - An array of strings (16-bit)
  - Byte 0x0c - uint32_t - number of strings
** Byte 0x0c - uint32_t - number of strings
  - Byte 0x10 - Strings - strings in format listed for single string (size + string)
** Byte 0x10 - Strings - strings in format listed for single string (size + string)
- Custom Struct - A set of different types specific to the message (SMS messages, call lists, etc...)
* Custom Struct * A set of different types specific to the message (SMS messages, call lists, etc...)
*** RIL Parcel - Process -> rild
 
=== RIL Parcel - Process -> rild ===


Each RIL Socket Write has the following format:
Each RIL Socket Write has the following format:


- Byte 0x00 - uint32_t - Header (Size of Following Parcel)
* Byte 0x00 - uint32_t - Header (Size of Following Parcel)
  - PARCEL BEGINS AFTER THIS FIELD
** PARCEL BEGINS AFTER THIS FIELD
- Byte 0x04 - uint32_t - RIL Event ID (IDs available in glue/gonk/hardware/ril/include/telephony/ril.h)
* Byte 0x04 - uint32_t - RIL Event ID (IDs available in glue/gonk/hardware/ril/include/telephony/ril.h)
- Byte 0x08 - uint32_t - Packet Serial Number (Used to track send/receive order)
* Byte 0x08 - uint32_t - Packet Serial Number (Used to track send/receive order)
- Byte 0x0c - void* - Event Data
* Byte 0x0c - void* - Event Data


*** RIL Parcel - rild -> Process (solicited reply)
=== RIL Parcel - rild -> Process (solicited reply) ===


Each RIL Socket Read (for a solicited response) has the following format:
Each RIL Socket Read (for a solicited response) has the following format:


- Byte 0x00 - uint32_t - Header (Size of Following Parcel)
* Byte 0x00 - uint32_t - Header (Size of Following Parcel)
  - PARCEL BEGINS AFTER THIS FIELD
** PARCEL BEGINS AFTER THIS FIELD
- Byte 0x04 - uint32_t - 0 (To signify it is a reply to a previously sent solicited request)
* Byte 0x04 - uint32_t - 0 (To signify it is a reply to a previously sent solicited request)
- Byte 0x08 - uint32_t - Packet Serial Number (Used to track send/receive order)
* Byte 0x08 - uint32_t - Packet Serial Number (Used to track send/receive order)
- Byte 0x0c - void* - Event Data
* Byte 0x0c - void* - Event Data


It is expected that the client maintains a list of previously made
It is expected that the client maintains a list of previously made
Line 108: Line 97:
the fields in the ril.h file.
the fields in the ril.h file.


*** RIL Parcel - rild -> Process (unsolicited event)
=== RIL Parcel - rild -> Process (unsolicited event) ===
 
Each RIL Socket Read (for a solicited response) has the following format:
Each RIL Socket Read (for a solicited response) has the following format:


- Byte 0x00 - uint32_t - Header (Size of Following Parcel)
* Byte 0x00 - uint32_t - Header (Size of Following Parcel)
  - PARCEL BEGINS AFTER THIS FIELD
** PARCEL BEGINS AFTER THIS FIELD
- Byte 0x04 - uint32_t - 1 (To signify it is a reply to a previously sent solicited request)
* Byte 0x04 - uint32_t - 1 (To signify it is a reply to a previously sent solicited request)
- Byte 0x08 - uint32_t - RIL Event ID (IDs available in glue/gonk/hardware/ril/include/telephony/ril.h)
* Byte 0x08 - uint32_t - RIL Event ID (IDs available in glue/gonk/hardware/ril/include/telephony/ril.h)
- Byte 0x0c - void* - Event Data
* Byte 0x0c - void* - Event Data


The client responds (as needed) to unsolicited events by sending a
The client responds (as needed) to unsolicited events by sending a
Line 123: Line 113:
the fields in the ril.h file.
the fields in the ril.h file.


* Phone Workflow
= Phone Workflow =
** Initialization
 
== Initialization ==
 
The initialization step is required to turn the radio on.
The initialization step is required to turn the radio on.
- Program connects to rild socket
- Program connects to rild socket
Line 130: Line 122:
- Program: SCREEN_STATE to TRUE
- Program: SCREEN_STATE to TRUE
- Program: RADIO_POWER (Turns radio on, if radio status is RADIO_STATE_OFF)
- Program: RADIO_POWER (Turns radio on, if radio status is RADIO_STATE_OFF)
** Service Status Update
 
- Radio: UNSOL_RESPONSE_NETWORK_STATE_CHANGED
== Service Status Update ==
- Program: OPERATOR
 
- Program: REGISTRATION_STATE
* Radio: UNSOL_RESPONSE_NETWORK_STATE_CHANGED
- Program: GPRS_REGISTRATION_STATE
* Program: OPERATOR
** Dialing
* Program: REGISTRATION_STATE
- Go through initialization and Service Status Update steps
* Program: GPRS_REGISTRATION_STATE
- Program: DIAL
 
(Just dialing doesn't work)
== Dialing ==
** Hanging Up
 
* Go through initialization and Service Status Update steps
* Program: DIAL
 
== Hanging Up ==
 
- Android app usually sends REQUEST_HANGUP_FOREGROUND_RESUME_BACKGROUND
- Android app usually sends REQUEST_HANGUP_FOREGROUND_RESUME_BACKGROUND
- Continually checks GET_CURRENT_CALLS, which may error the first time around? [[https://github.com/kmachulis-mozilla/b2g-dialer-test/issues/13]]
- Continually checks GET_CURRENT_CALLS, which may error the first time around? [https://github.com/kmachulis-mozilla/b2g-dialer-test/issues/13]
** Call Receive
 
** SMS Receive
== Call Receive ==
- Radio: UNSOL_RESPONSE_NEW_SMS
 
- Program: RIL_REQUEST_SMS_ACKNOWLEDGE
== SMS Receive ==
* Gecko Design
* Radio: UNSOL_RESPONSE_NEW_SMS
For preliminary design documentation of WebTelephony/WebAPI, see [[https://wiki.mozilla.org/WebAPI/WebTelephony]]
* Program: RIL_REQUEST_SMS_ACKNOWLEDGE
** Design Overview
 
= Gecko Design =
 
For preliminary design documentation of WebTelephony/WebAPI, see [https://wiki.mozilla.org/WebAPI/WebTelephony]
 
== Design Overview ==
 
The RIL communications system will consist events in the context of 3
The RIL communications system will consist events in the context of 3
threads, as well as a socket proxy daemon:
threads, as well as a socket proxy daemon:


- The IPC Thread, where IO to the Radio Socket will happen
* The IPC Thread, where IO to the Radio Socket will happen
- A JS Worker thread, where low level telephony support (parsing
* A JS Worker thread, where low level telephony support (parsing
   parcels to/from socket, dealing with GSM/CDMA/SIP and SIM card
   parcels to/from socket, dealing with GSM/CDMA/SIP and SIM card
   commands, etc...) will be implemented
   commands, etc...) will be implemented
- The Main Gecko Thread, where the Telephony DOM will expose high
* The Main Gecko Thread, where the Telephony DOM will expose high
   level commands to the navigator.phone object.
   level commands to the navigator.phone object.
** Radio Base Class - IO Thread
 
== Radio Base Class - IO Thread ==
 
The Radio Base Class declares the basic communication function
The Radio Base Class declares the basic communication function
signatures for radios, as well as managing a queue of binary blobs
signatures for radios, as well as managing a queue of binary blobs
Line 166: Line 171:
use) creation up into the Telephone class, keeping Radio in its own
use) creation up into the Telephone class, keeping Radio in its own
thread to deal with I/O.
thread to deal with I/O.
** Radio JS Worker Thread
 
== Radio JS Worker Thread ==
 
The Radio Implementation class will handle
The Radio Implementation class will handle


- Providing an interface to phone status (Network Name, Signal
* Providing an interface to phone status (Network Name, Signal
   Strength, Current Calls, Radio Events, etc...)
   Strength, Current Calls, Radio Events, etc...)
- Creating and Managing data in flight from/to the radio
* Creating and Managing data in flight from/to the radio


Radio communication at the parcel level happens in the worker thread,
Radio communication at the parcel level happens in the worker thread,
Line 178: Line 185:
incoming calls.
incoming calls.


** Telephony DOM
== Telephony DOM ==
 
The Telephone class is responsible for exposing high level functions
The Telephone class is responsible for exposing high level functions
to Javascript (Dial, Hangup, SMS, etc...). More information on this is
to Javascript (Dial, Hangup, SMS, etc...). More information on this is
available as part of the WebTelephony project.
available as part of the WebTelephony project.
* Utilities and Tips
* Utilities and Tips
** Building
** Building
- Set the path of your local Android NDK and B2G, i.e. export
* Set the path of your local Android NDK and B2G, i.e. export
   NDK=/opt/android-ndk-r6b
   NDK=/opt/android-ndk-r6b
- Run scripts/android_env.sh
* Run scripts/android_env.sh
- cmake .
* cmake .
- make
* make
 
** Debugging
 
The command "logcat -b radio" in the android shell will print all radio messages
 
Tracing the packet formats going between com.android.phone and the
rild socket can be achieved by watching strace on the rild
process. Due to the fact that rild spawns multiple threads, this
should be done with the fork option, i.e.
 
strace -p XXXX -f
 
To trigger events that happens from outside the network, the
rild-debug socket is provided by rild. This socket responds to a
different set of commands, in order to inject RIL events into the ril
core. It's mainly used for testing new ril implementations.
 
** Tools
*** ADB convenience
To automate some of the common tasks involved with resetting processes
on the phone, watching logs, etc... I've made a few different custom
targets in the CMake file. These can be run using
 
make [target_name]
 
in the out-of-source build directory. The targets are:
 
- adbpush - Push b2g-dialer-test binary to phone.
- adbdial - Run b2g-dialer-test. Currently does not work.
- adbrwmount - Remount / and /system as rw for duration of session
  (i.e. until next reboot)
- adbjavaon/adbjavaoff - With the patch to the android code, java now
  tries to connect to /dev/socket/rild2 instead of /dev/socket/rild.
  This allows us to connect to rild via our own process when needed,
  but also means we can symlink rild2 to rild when we want to watch
  how android interacts with something (useful for analyzing code
  flow). adbjavaon creates the symlink (at which point b2g-dialer-test
  binary will fail due to needing exclusing socket access). adbjavaoff
  will remove the symlink and kill the android phone process, causing
  it to drop its connection to the socket.
 
*** b2g-dialer-forward
b2g-dialer-forward is a utility for forwarding the rild unix socket to
the network, so that developers can work on API. adb forward is
available to unix sockets, but due to the account access check for
'radio' by rild, we need to establish the network port as root, then
communicate with the socket as rild.
 
b2g-dialer-forward connects the rild unix socket to port 5555 on the
phone. This can then be forwarded to the desktop using adb forward
with the tcp protocol.
 
As an example, the dialer.py test script uses this utility to talk to
the phone daemon without having to actually run on the phone.
 
** Relevant Websites
- [[http://i-miss-erin.blogspot.com/2009/11/radio-layer-interface-in-android.html][Hooking up Android to a GSM radio on the BeagleBoard]]
- [[http://www.netmite.com/android/mydroid/development/pdk/docs/telephony.html][libril Documentation]]
- [[https://groups.google.com/forum/#!topic/android-porting/lo90a3Bb1nA][Small thread on ril stuff]]
- [[http://www.slideshare.net/ssusere3af56/android-radio-layer-interface][Android Radio Interface Layer]]
- [[http://www.slideshare.net/dpsmarques/android-telephony-stack][Android Telephony Stack]]
 
 


== Relevant Websites ==
* [[http://i-miss-erin.blogspot.com/2009/11/radio-layer-interface-in-android.html][Hooking up Android to a GSM radio on the BeagleBoard]]
* [[http://www.netmite.com/android/mydroid/development/pdk/docs/telephony.html][libril Documentation]]
* [[https://groups.google.com/forum/#!topic/android-porting/lo90a3Bb1nA][Small thread on ril stuff]]
* [[http://www.slideshare.net/ssusere3af56/android-radio-layer-interface][Android Radio Interface Layer]]
* [[http://www.slideshare.net/dpsmarques/android-telephony-stack][Android Telephony Stack]]


= Relevant Bugs  =
= Relevant Bugs  =
Kmachulis
44

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/364466"

Navigation menu