diff options
Diffstat (limited to 'src/driver.h')
| -rw-r--r-- | src/driver.h | 332 |
1 files changed, 332 insertions, 0 deletions
diff --git a/src/driver.h b/src/driver.h new file mode 100644 index 00000000..543fc771 --- /dev/null +++ b/src/driver.h @@ -0,0 +1,332 @@ +/* + * + * oFono - Open Source Telephony + * + * Copyright (C) 2008-2009 Intel Corporation. All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * + */ + +struct ofono_modem; + +/* 27.007 Section 6.2 */ +enum ofono_clir_option { + OFONO_CLIR_OPTION_DEFAULT = 0, + OFONO_CLIR_OPTION_INVOCATION, + OFONO_CLIR_OPTION_SUPPRESSION +}; + +/* 27.007 Section 6.2 */ +enum ofono_cug_option { + OFONO_CUG_OPTION_DEFAULT = 0, + OFONO_CUG_OPTION_INVOCATION = 1, +}; + +enum ofono_error_type { + OFONO_ERROR_TYPE_NO_ERROR = 0, + OFONO_ERROR_TYPE_CME, + OFONO_ERROR_TYPE_CMS, + OFONO_ERROR_TYPE_CEER, + OFONO_ERROR_TYPE_FAILURE +}; + +struct ofono_error { + enum ofono_error_type type; + int error; +}; + +enum ofono_disconnect_reason { + OFONO_DISCONNECT_REASON_UNKNOWN = 0, + OFONO_DISCONNECT_REASON_LOCAL_HANGUP, + OFONO_DISCONNECT_REASON_REMOTE_HANGUP, + OFONO_DISCONNECT_REASON_ERROR, +}; + +#define OFONO_MAX_PHONE_NUMBER_LENGTH 20 + +struct ofono_call { + unsigned id; + int type; + int direction; + int status; + char phone_number[OFONO_MAX_PHONE_NUMBER_LENGTH + 1]; + int number_type; + int clip_validity; +}; + +/* Theoretical limit is 16, but each GSM char can be encoded into + * * 3 UTF8 characters resulting in 16*3=48 chars + * */ +#define OFONO_MAX_OPERATOR_NAME_LENGTH 63 + +struct ofono_network_operator { + char name[OFONO_MAX_OPERATOR_NAME_LENGTH + 1]; + short mcc; + short mnc; + int status; + int tech; +}; + +/* 27.007 Section 7.11 Call Forwarding */ +struct ofono_cf_condition { + int status; + int cls; + char phone_number[OFONO_MAX_PHONE_NUMBER_LENGTH + 1]; + int number_type; + int time; +}; + +/* 27.007 Section 7.12 Call Waiting */ +struct ofono_cw_condition { + int status; + int cls; +}; + +/* Notification functions, the integer values here should map to + * values obtained from the modem. The enumerations are the same + * as the values for the fields found in 3GPP TS 27.007 + * + * Pass in the integer value -1 if the value is not known + * Pass in NULL string value if the value is not known + */ +typedef void (*ofono_generic_cb_t)(const struct ofono_error *error, + void *data); + +typedef void (*ofono_call_list_cb_t)(const struct ofono_error *error, + int numcalls, + const struct ofono_call *call_list, + void *data); + +typedef void (*ofono_current_operator_cb_t)(const struct ofono_error *error, + const struct ofono_network_operator *op, + void *data); + +typedef void (*ofono_operator_list_cb_t)(const struct ofono_error *error, + int total, + const struct ofono_network_operator *list, + void *data); + +typedef void (*ofono_registration_status_cb_t)(const struct ofono_error *error, + int status, int lac, int ci, int tech, + void *data); + +typedef void (*ofono_signal_strength_cb_t)(const struct ofono_error *error, + int strength, void *data); + +typedef void (*ofono_call_forwarding_query_cb_t)(const struct ofono_error *error, + int total, + const struct ofono_cf_condition *list, + void *data); + +typedef void (*ofono_modem_attribute_query_cb_t)(const struct ofono_error *error, + const char *attribute, void *data); + +typedef void (*ofono_call_setting_status_cb_t)(const struct ofono_error *error, + int status, void *data); + +typedef void (*ofono_clir_setting_cb_t)(const struct ofono_error *error, + int override, int network, void *data); + +typedef void (*ofono_call_waiting_status_cb_t)(const struct ofono_error *error, + int num, struct ofono_cw_condition *cond, + void *data); + +typedef void (*ofono_call_meter_query_cb_t)(const struct ofono_error *error, + int value, void *data); + +typedef void (*ofono_call_meter_puct_query_cb_t)(const struct ofono_error *error, + const char *currency, double ppu, + void *data); + +struct ofono_modem_attribute_ops { + void (*query_manufacturer)(struct ofono_modem *modem, + ofono_modem_attribute_query_cb_t cb, void *data); + void (*query_serial)(struct ofono_modem *modem, + ofono_modem_attribute_query_cb_t cb, void *data); + void (*query_model)(struct ofono_modem *modem, + ofono_modem_attribute_query_cb_t cb, void *data); + void (*query_revision)(struct ofono_modem *modem, + ofono_modem_attribute_query_cb_t cb, void *data); +}; + +struct ofono_modem *ofono_modem_register(struct ofono_modem_attribute_ops *ops); +int ofono_modem_unregister(struct ofono_modem *modem); + +void ofono_modem_set_userdata(struct ofono_modem *modem, void *data); +void *ofono_modem_userdata(struct ofono_modem *modem); + +/* Network related functions, including registration status, operator selection + * and signal strength indicators. + * + * It is up to the plugin to implement CSQ polling if the modem does not support + * vendor extensions for signal strength notification. + */ +struct ofono_network_registration_ops { + void (*registration_status)(struct ofono_modem *modem, + ofono_registration_status_cb_t cb, void *data); + void (*current_operator)(struct ofono_modem *modem, + ofono_current_operator_cb_t cb, void *data); + void (*list_operators)(struct ofono_modem *modem, + ofono_operator_list_cb_t cb, void *data); + void (*register_auto)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*register_manual)(struct ofono_modem *modem, + const struct ofono_network_operator *oper, + ofono_generic_cb_t cb, void *data); + void (*deregister)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*signal_strength)(struct ofono_modem *modem, + ofono_signal_strength_cb_t, void *data); +}; + +void ofono_signal_strength_notify(struct ofono_modem *modem, int strength); +void ofono_network_registration_notify(struct ofono_modem *modem, int status, + int lac, int ci, int tech); +int ofono_network_registration_register(struct ofono_modem *modem, + struct ofono_network_registration_ops *ops); +void ofono_network_registration_unregister(struct ofono_modem *modem); + +/* Voice call related functionality, including ATD, ATA, +CHLD, CTFR, CLCC, + * SSN notifications (CSSI and CSSU) and VTS. + * + * It is up to the plugin to implement polling of CLCC if the modem does + * not support vendor extensions for call progress indication. + */ +struct ofono_voicecall_ops { + void (*dial)(struct ofono_modem *modem, const char *number, + int number_type, enum ofono_clir_option clir, + enum ofono_cug_option cug, ofono_generic_cb_t cb, + void *data); + void (*answer)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*hangup)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*list_calls)(struct ofono_modem *modem, + ofono_call_list_cb_t cb, void *data); + void (*hold_all_active)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*release_all_held)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*set_udub)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*release_all_active)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*release_specific)(struct ofono_modem *modem, int id, + ofono_generic_cb_t cb, void *data); + void (*private_chat)(struct ofono_modem *modem, int id, + ofono_generic_cb_t cb, void *data); + void (*create_multiparty)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*transfer)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*deflect)(struct ofono_modem *modem, const char *number, + int number_type, ofono_generic_cb_t cb, void *data); + void (*swap_without_accept)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); + void (*send_tones)(struct ofono_modem *modem, const char *tones, + ofono_generic_cb_t cb, void *data); +}; + +void ofono_voicecall_notify(struct ofono_modem *modem, const struct ofono_call *call); +void ofono_voicecall_disconnected(struct ofono_modem *modem, int id, + enum ofono_disconnect_reason reason, + const struct ofono_error *error); +void ofono_voicecall_cssi(struct ofono_modem *modem, int code, int index); +void ofono_voicecall_cssu(struct ofono_modem *modem, int code, int index, + const char *number, int number_type); + +int ofono_voicecall_register(struct ofono_modem *modem, struct ofono_voicecall_ops *ops); +void ofono_voicecall_unregister(struct ofono_modem *modem); + +struct ofono_call_forwarding_ops { + void (*activation)(struct ofono_modem *modem, int type, int cls, + ofono_generic_cb_t cb, void *data); + void (*registration)(struct ofono_modem *modem, int type, int cls, + const char *number, int number_type, int time, + ofono_generic_cb_t cb, void *data); + void (*deactivation)(struct ofono_modem *modem, int type, int cls, + ofono_generic_cb_t cb, void *data); + void (*erasure)(struct ofono_modem *modem, int type, int cls, + ofono_generic_cb_t cb, void *data); + void (*query)(struct ofono_modem *modem, int type, int cls, + ofono_call_forwarding_query_cb_t cb, void *data); +}; + +int ofono_call_forwarding_register(struct ofono_modem *modem, + struct ofono_call_forwarding_ops *ops); +void ofono_call_forwarding_unregister(struct ofono_modem *modem); + +struct ofono_ussd_ops { + void (*request)(struct ofono_modem *modem, const char *str, + ofono_generic_cb_t cb, void *data); + void (*cancel)(struct ofono_modem *modem, + ofono_generic_cb_t cb, void *data); +}; + +void ofono_ussd_notify(struct ofono_modem *modem, int status, const char *str); +int ofono_ussd_register(struct ofono_modem *modem, struct ofono_ussd_ops *ops); +void ofono_ussd_unregister(struct ofono_modem *modem); + +struct ofono_call_settings_ops { + void (*clip_query)(struct ofono_modem *modem, + ofono_call_setting_status_cb_t cb, void *data); + void (*colp_query)(struct ofono_modem *modem, + ofono_call_setting_status_cb_t cb, void *data); + void (*clir_query)(struct ofono_modem *modem, ofono_clir_setting_cb_t cb, + void *data); + void (*colr_query)(struct ofono_modem *modem, + ofono_call_setting_status_cb_t cb, void *data); + void (*clir_set)(struct ofono_modem *modem, int mode, ofono_generic_cb_t cb, + void *data); +}; + +int ofono_call_settings_register(struct ofono_modem *modem, + struct ofono_call_settings_ops *ops); +void ofono_call_settings_unregister(struct ofono_modem *modem); + +struct ofono_call_waiting_ops { + void (*query)(struct ofono_modem *modem, int cls, + ofono_call_waiting_status_cb_t cb, void *data); + void (*set)(struct ofono_modem *modem, int mode, int cls, + ofono_generic_cb_t cb, void *data); +}; + +int ofono_call_waiting_register(struct ofono_modem *modem, + struct ofono_call_waiting_ops *ops); +void ofono_call_waiting_unregister(struct ofono_modem *modem); + +struct ofono_call_meter_ops { + void (*call_meter_query)(struct ofono_modem *modem, + ofono_call_meter_query_cb_t cb, void *data); + void (*acm_query)(struct ofono_modem *modem, + ofono_call_meter_query_cb_t cb, void *data); + void (*acm_reset)(struct ofono_modem *modem, const char *sim_pin2, + ofono_generic_cb_t cb, void *data); + void (*acm_max_query)(struct ofono_modem *modem, + ofono_call_meter_query_cb_t cb, void *data); + void (*acm_max_set)(struct ofono_modem *modem, int new_value, + const char *sim_pin2, ofono_generic_cb_t cb, void *data); + void (*puct_query)(struct ofono_modem *modem, + ofono_call_meter_puct_query_cb_t cb, void *data); + void (*puct_set)(struct ofono_modem *modem, const char *currency, + double ppu, const char *sim_pin2, + ofono_generic_cb_t cb, void *data); +}; + +int ofono_call_meter_register(struct ofono_modem *modem, + struct ofono_call_meter_ops *ops); +void ofono_call_meter_unregister(struct ofono_modem *modem); +void ofono_call_meter_maximum_notify(struct ofono_modem *modem); +void ofono_call_meter_changed_notify(struct ofono_modem *modem, int new_value); |