Add comment to RIL_UNSOL_CALL_RING.

[android-x86/hardware-ril.git] / include / telephony / ril.h

diff --git a/include/telephony/ril.h b/include/telephony/ril.h
index ca8c1df..098954e 100644 (file)
--- a/include/telephony/ril.h
+++ b/include/telephony/ril.h
@@ -280,20 +280,6 @@ typedef struct {
                                    (MT only, may be NULL). */
 } RIL_SuppSvcNotification;
 
-/* TODO: Remove these once reference-ril cleanup is done. */
-#define RIL_SIM_ABSENT                  0
-#define RIL_SIM_NOT_READY               1
-/* RIL_SIM_READY means that the radio state is RADIO_STATE_SIM_READY.
- * This is more
- * than "+CPIN: READY". It also means the radio is ready for SIM I/O
- */
-#define RIL_SIM_READY                   2
-#define RIL_SIM_PIN                     3
-#define RIL_SIM_PUK                     4
-#define RIL_SIM_NETWORK_PERSONALIZATION 5
-
-/* see RIL_REQUEST_GET_SIM_STATUS */
-
 #define RIL_CARD_MAX_APPS     8
 
 typedef enum {
@@ -613,13 +599,6 @@ typedef struct {
  * "data" is NULL
  *
  * "response" is const RIL_CardStatus *
-
- *
- * If the radio is off or unavailable, return RIL_SIM_NOT_READY
- *
- * Please note: RIL_SIM_READY means that the radio state
- * is RADIO_STATE_SIM_READY.   This is more than "+CPIN: READY".
- * It also means the radio is ready for SIM I/O
  *
  * Valid errors:
  *  Must never fail
@@ -629,7 +608,7 @@ typedef struct {
 /**
  * RIL_REQUEST_ENTER_SIM_PIN
  *
- * Supplies SIM PIN. Only called if SIM status is RIL_SIM_PIN
+ * Supplies SIM PIN. Only called if RIL_CardStatus has RIL_APPSTATE_PIN state
  *
  * "data" is const char **
  * ((const char **)data)[0] is PIN value
@@ -1024,7 +1003,8 @@ typedef struct {
  * ((const char **)response)[3] indicates the available radio technology 0-7,
  *                                  0 - Unknown, 1 - GPRS, 2 - EDGE, 3 - UMTS,
  *                                  4 - IS95A, 5 - IS95B, 6 - 1xRTT,
- *                                  7 - EvDo Rev. 0, 8 - EvDo Rev. A
+ *                                  7 - EvDo Rev. 0, 8 - EvDo Rev. A,
+ *                                  9 - HSDPA, 10 - HSUPA, 11 - HSPA
  * ((const char **)response)[4] is Base Station ID if registered on a CDMA
  *                              system or NULL if not.  Base Station ID in
  *                              decimal format
@@ -1088,7 +1068,7 @@ typedef struct {
  *
  * "data" is NULL
  * "response" is a "char **"
- * ((const char **)response)[0] is registration state 0-5 from TS 27.007 7.2
+ * ((const char **)response)[0] is registration state 0-5 from TS 27.007 10.1.20 AT+CGREG
  * ((const char **)response)[1] is LAC if registered or NULL if not
  * ((const char **)response)[2] is CID if registered or NULL if not
  * ((const char **)response)[3] indicates the available radio technology, where:
@@ -1096,6 +1076,9 @@ typedef struct {
  *      1 == GPRS only
  *      2 == EDGE
  *      3 == UMTS
+ *      9 == HSDPA
+ *      10 == HSUPA
+ *      11 == HSPA
  *
  * LAC and CID are in hexadecimal format.
  * valid LAC are 0x0000 - 0xffff
@@ -2721,9 +2704,9 @@ typedef struct {
  * "response" is const char **
  * ((const char **)response)[0] is MDN if CDMA subscription is available
  * ((const char **)response)[1] is a comma separated list of H_SID (Home SID) if
- *                              CDMA subscription is available, in hexadecimal format
+ *                              CDMA subscription is available, in decimal format
  * ((const char **)response)[2] is a comma separated list of H_NID (Home NID) if
- *                              CDMA subscription is available, in hexadecimal format
+ *                              CDMA subscription is available, in decimal format
  * ((const char **)response)[3] is MIN (10 digits, MIN2+MIN1) if CDMA subscription is available
  * ((const char **)response)[4] is PRL version if CDMA subscription is available
  *
@@ -3151,6 +3134,15 @@ typedef struct {
  * RIL_UNSOL_CALL_RING
  *
  * Ring indication for an incoming call (eg, RING or CRING event).
+ * There must be at least one RIL_UNSOL_CALL_RING at the beginning
+ * of a call and sending multiple is optional. If the system property
+ * ro.telephony.call_ring.multiple is false then the upper layers
+ * will generate the multiple events internally. Otherwise the vendor
+ * ril must generate multiple RIL_UNSOL_CALL_RING if
+ * ro.telephony.call_ring.multiple is true or if it is absent.
+ *
+ * The rate of these events is controlled by ro.telephony.call_ring.delay
+ * and has a default value of 3000 (3 seconds) if absent.
  *
  * "data" is null for GSM
  * "data" is const RIL_CDMA_SignalInfoRecord * if CDMA