libgammu/gsmstate.h

   1 /* (c) 2002-2004 by Marcin Wiacek & Michal Cihar */
   2
   3 /**
   4  * @file gsmstate.h
   5  * @author Michal Čihař
   6  * @author Marcin Wiacek
   7  */
   8
   9 /**
  10  * \addtogroup StateMachine
  11  *
  12  * @{
  13  */
  14
  15 #ifndef __gsm_state_h
  16 #define __gsm_state_h
  17
  18 #include <time.h>
  19
  20 #include <gammu-file.h>
  21 #include <gammu-info.h>
  22 #include <gammu-config.h>
  23 #include <gammu-keys.h>
  24 #include <gammu-security.h>
  25 #include <gammu-callback.h>
  26 #include <gammu-settings.h>
  27 #include <gammu-misc.h>
  28 #include <gammu-category.h>
  29 #include <gammu-backup.h>
  30 #include <string.h>
  31
  32 typedef struct _GSM_User                GSM_User;
  33
  34 #ifdef GSM_ENABLE_NOKIA3650
  35 #  include "phone/nokia/wd2/n3650.h"
  36 #endif
  37 #ifdef GSM_ENABLE_NOKIA650
  38 #  include "phone/nokia/dct3/n0650.h"
  39 #endif
  40 #ifdef GSM_ENABLE_NOKIA6110
  41 #  include "phone/nokia/dct3/n6110.h"
  42 #endif
  43 #ifdef GSM_ENABLE_NOKIA3320
  44 #  include "phone/nokia/dct4s40/n3320.h"
  45 #endif
  46 #ifdef GSM_ENABLE_NOKIA6510
  47 #  include "phone/nokia/dct4s40/6510/n6510.h"
  48 #endif
  49 #ifdef GSM_ENABLE_NOKIA7110
  50 #  include "phone/nokia/dct3/n7110.h"
  51 #endif
  52 #ifdef GSM_ENABLE_NOKIA9210
  53 #  include "phone/nokia/dct3/n9210.h"
  54 #endif
  55 #ifdef GSM_ENABLE_ATGEN
  56 #  include "phone/at/atgen.h"
  57 #endif
  58 #ifdef GSM_ENABLE_ALCATEL
  59 #  include "phone/alcatel/alcatel.h"
  60 #endif
  61 #ifdef GSM_ENABLE_ATOBEX
  62 #  include "phone/atobex/atobex.h"
  63 #endif
  64 #ifdef GSM_ENABLE_OBEXGEN
  65 #  include "phone/obex/obexgen.h"
  66 #endif
  67 #ifdef GSM_ENABLE_GNAPGEN
  68 #  include "phone/symbian/gnapgen.h"
  69 #endif
  70 #ifdef GSM_ENABLE_S60
  71 #  include "phone/s60/s60phone.h"
  72 #endif
  73 #  include "phone/dummy/dummy.h"
  74
  75 #ifndef GSM_USED_MBUS2
  76 #  undef GSM_ENABLE_MBUS2
  77 #endif
  78 #ifndef GSM_USED_FBUS2
  79 #  undef GSM_ENABLE_FBUS2
  80 #endif
  81 #ifndef GSM_USED_FBUS2DLR3
  82 #  undef GSM_ENABLE_FBUS2DLR3
  83 #endif
  84 #ifndef GSM_USED_DKU2PHONET
  85 #  undef GSM_ENABLE_DKU2PHONET
  86 #endif
  87 #ifndef GSM_USED_DKU2AT
  88 #  undef GSM_ENABLE_DKU2AT
  89 #endif
  90 #ifndef GSM_USED_DKU5FBUS2
  91 #  undef GSM_ENABLE_DKU5FBUS2
  92 #endif
  93 #ifndef GSM_USED_FBUS2PL2303
  94 #  undef GSM_ENABLE_FBUS2PL2303
  95 #endif
  96 #ifndef GSM_USED_FBUS2BLUE
  97 #  undef GSM_ENABLE_FBUS2BLUE
  98 #endif
  99 #ifndef GSM_USED_FBUS2IRDA
 100 #  undef GSM_ENABLE_FBUS2IRDA
 101 #endif
 102 #ifndef GSM_USED_PHONETBLUE
 103 #  undef GSM_ENABLE_PHONETBLUE
 104 #endif
 105 #ifndef GSM_USED_AT
 106 #  undef GSM_ENABLE_AT
 107 #endif
 108 #ifndef GSM_USED_ALCABUS
 109 #  undef GSM_ENABLE_ALCABUS
 110 #endif
 111 #ifndef GSM_USED_IRDAPHONET
 112 #  undef GSM_ENABLE_IRDAPHONET
 113 #endif
 114 #ifndef GSM_USED_IRDAAT
 115 #  undef GSM_ENABLE_IRDAAT
 116 #endif
 117 #ifndef GSM_USED_IRDAOBEX
 118 #  undef GSM_ENABLE_IRDAOBEX
 119 #endif
 120 #ifndef GSM_USED_BLUEFBUS2
 121 #  undef GSM_ENABLE_BLUEFBUS2
 122 #endif
 123 #ifndef GSM_USED_BLUEOBEX
 124 #  undef GSM_ENABLE_BLUEOBEX
 125 #endif
 126 #ifndef GSM_USED_BLUEPHONET
 127 #  undef GSM_ENABLE_BLUEPHONET
 128 #endif
 129 #ifndef GSM_USED_BLUEAT
 130 #  undef GSM_ENABLE_BLUEAT
 131 #endif
 132 #ifndef GSM_USED_BLUEGNAPBUS
 133 #  undef GSM_ENABLE_BLUEGNAPBUS
 134 #endif
 135
 136 #include "protocol/protocol.h"
 137 #if defined(GSM_ENABLE_FBUS2) || defined(GSM_ENABLE_FBUS2IRDA) || defined(GSM_ENABLE_FBUS2DLR3) || defined(GSM_ENABLE_FBUS2BLUE) || defined(GSM_ENABLE_BLUEFBUS2) || defined(GSM_ENABLE_DKU5FBUS2) || defined(GSM_ENABLE_FBUS2PL2303)
 138 #  include "protocol/nokia/fbus2.h"
 139 #endif
 140 #ifdef GSM_ENABLE_MBUS2
 141 #  include "protocol/nokia/mbus2.h"
 142 #endif
 143 #if defined(GSM_ENABLE_PHONETBLUE) || defined(GSM_ENABLE_IRDAPHONET) || defined(GSM_ENABLE_BLUEPHONET) || defined(GSM_ENABLE_DKU2PHONET)
 144 #  include "protocol/nokia/phonet.h"
 145 #endif
 146 #if defined(GSM_ENABLE_AT) || defined(GSM_ENABLE_BLUEAT) || defined(GSM_ENABLE_IRDAAT) || defined(GSM_ENABLE_DKU2AT)
 147 #  include "protocol/at/at.h"
 148 #endif
 149 #ifdef GSM_ENABLE_ALCABUS
 150 #  include "protocol/alcatel/alcabus.h"
 151 #endif
 152 #if defined(GSM_ENABLE_IRDAOBEX) || defined(GSM_ENABLE_BLUEOBEX) || defined(GSM_ENABLE_ATOBEX)
 153 #  include "protocol/obex/obex.h"
 154 #endif
 155 #if defined(GSM_ENABLE_BLUEGNAPBUS) || defined(GSM_ENABLE_IRDAGNAPBUS)
 156 #  include "protocol/symbian/gnapbus.h"
 157 #endif
 158 #if defined(GSM_ENABLE_S60)
 159 #  include "protocol/s60/s60.h"
 160 #endif
 161
 162 #define GSM_ENABLE_SERIALDEVICE
 163 #ifndef GSM_USED_SERIALDEVICE
 164 #  undef GSM_ENABLE_SERIALDEVICE
 165 #endif
 166 #ifdef LIBUSB_FOUND
 167 #define GSM_ENABLE_USBDEVICE
 168 #endif
 169 #ifndef GSM_USED_USBDEVICE
 170 #  undef GSM_ENABLE_USBDEVICE
 171 #endif
 172 #define GSM_ENABLE_IRDADEVICE
 173 #ifndef GSM_USED_IRDADEVICE
 174 #  undef GSM_ENABLE_IRDADEVICE
 175 #endif
 176 #if defined(BLUEZ_FOUND) || defined(BSD_BLUE_FOUND) || defined(OSX_BLUE_FOUND) || defined(WIN32)
 177 #  define GSM_ENABLE_BLUETOOTHDEVICE
 178 #endif
 179 #ifndef GSM_USED_BLUETOOTHDEVICE
 180 #  undef GSM_ENABLE_BLUETOOTHDEVICE
 181 #endif
 182
 183 #ifdef DJGPP
 184 #  undef GSM_ENABLE_IRDADEVICE
 185 #  undef GSM_ENABLE_IRDAPHONET
 186 #  undef GSM_ENABLE_IRDAOBEX
 187 #  undef GSM_ENABLE_IRDAAT
 188 #  undef GSM_ENABLE_IRDAGNAPBUS
 189 #  undef GSM_ENABLE_DKU2AT
 190 #  undef GSM_ENABLE_FBUS2IRDA
 191 #  undef GSM_ENABLE_BLUETOOTHDEVICE
 192 #  undef GSM_ENABLE_BLUEPHONET
 193 #  undef GSM_ENABLE_BLUEOBEX
 194 #  undef GSM_ENABLE_BLUEAT
 195 #  undef GSM_ENABLE_BLUEFBUS2
 196 #  undef GSM_ENABLE_BLUEGNAPBUS
 197 #  undef GSM_ENABLE_PHONETBLUE
 198 #  undef GSM_ENABLE_FBUS2BLUE
 199 #endif
 200
 201 #ifdef GSM_ENABLE_SERIALDEVICE
 202 #  include "device/serial/ser_w32.h"
 203 #  include "device/serial/ser_unx.h"
 204 #  include "device/serial/ser_djg.h"
 205 #endif
 206 #ifdef GSM_ENABLE_USBDEVICE
 207 #  include "device/usb/usb.h"
 208 #endif
 209 #ifdef GSM_ENABLE_IRDADEVICE
 210 #  include "device/irda/irda.h"
 211 #endif
 212 #ifdef GSM_ENABLE_BLUETOOTHDEVICE
 213 #  include "device/bluetoth/bluetoth.h"
 214 #endif
 215
 216 #include "debug.h"
 217 #include "gsmreply.h"
 218
 219
 220 /* ------------------------- Device layer ---------------------------------- */
 221
 222 /**
 223  * Device functions, each device has to provide these.
 224  */
 225 typedef struct {
 226         /**
 227          * Opens device.
 228          */
 229         GSM_Error (*OpenDevice)        (GSM_StateMachine *s);
 230         /**
 231          * Closes device.
 232          */
 233         GSM_Error (*CloseDevice)       (GSM_StateMachine *s);
 234         /**
 235          * Sets parity for device.
 236          */
 237         GSM_Error (*DeviceSetParity)   (GSM_StateMachine *s, gboolean parity);
 238         /**
 239          * Sets dtr (data to read) and rts (ready to send) flags.
 240          */
 241         GSM_Error (*DeviceSetDtrRts)   (GSM_StateMachine *s, gboolean dtr, gboolean rts);
 242         /**
 243          * Sets device speed.
 244          */
 245         GSM_Error (*DeviceSetSpeed)    (GSM_StateMachine *s, int speed);
 246         /**
 247          * Attempts to read nbytes from device.
 248          */
 249         int       (*ReadDevice)        (GSM_StateMachine *s, void *buf, size_t nbytes);
 250         /**
 251          * Attempts to read nbytes from device.
 252          */
 253         int       (*WriteDevice)       (GSM_StateMachine *s, const void *buf, size_t nbytes);
 254 } GSM_Device_Functions;
 255
 256 #ifdef GSM_ENABLE_SERIALDEVICE
 257 /**
 258  * Serial device functions.
 259  */
 260 extern GSM_Device_Functions SerialDevice;
 261 #endif
 262 #ifdef GSM_ENABLE_IRDADEVICE
 263 /**
 264  * IrDA device functions.
 265  */
 266 extern GSM_Device_Functions IrdaDevice;
 267 #endif
 268 #ifdef GSM_ENABLE_BLUETOOTHDEVICE
 269 /**
 270  * Bluetooth device functions.
 271  */
 272 extern GSM_Device_Functions BlueToothDevice;
 273 #endif
 274 #ifdef GSM_ENABLE_USBDEVICE
 275 /**
 276  * Serial device functions.
 277  */
 278 extern GSM_Device_Functions FBUSUSBDevice;
 279 #endif
 280
 281 /**
 282  * Structure containing device specific data and pointer to device functions -
 283  * @ref GSM_Device_Functions. The data are in a union, so you can use only
 284  * one device at one time.
 285  */
 286 typedef struct {
 287         union {
 288                 /**
 289                  * Fake memeber to ensure union has always at least one member.
 290                  */
 291                 char fake;
 292 #ifdef GSM_ENABLE_SERIALDEVICE
 293                 /**
 294                  * Data for serial port device.
 295                  */
 296                 GSM_Device_SerialData           Serial;
 297 #endif
 298 #ifdef GSM_ENABLE_IRDADEVICE
 299                 /**
 300                  * Data for IrDA port device.
 301                  */
 302                 GSM_Device_IrdaData             Irda;
 303 #endif
 304 #ifdef GSM_ENABLE_BLUETOOTHDEVICE
 305                 /**
 306                  * Data for Bluetooth port device.
 307                  */
 308                 GSM_Device_BlueToothData        BlueTooth;
 309 #endif
 310 #ifdef GSM_ENABLE_USBDEVICE
 311                 /**
 312                  * Data for libusb-1.0 backend.
 313                  */
 314                 GSM_Device_USBData              USB;
 315 #endif
 316         } Data;
 317         /**
 318          * Functions for currently used device.
 319          */
 320         GSM_Device_Functions *Functions;
 321 } GSM_Device;
 322
 323 /* ---------------------- Protocol layer ----------------------------------- */
 324
 325 /**
 326  * Protocol functions, each protocol has to implement these.
 327  */
 328 typedef struct {
 329         /**
 330          * Writes message to device.
 331          */
 332         GSM_Error (*WriteMessage) (GSM_StateMachine *s, unsigned const char *buffer,
 333                                    int length, int type);
 334         /**
 335          * This one is called when character is received from device.
 336          */
 337         GSM_Error (*StateMachine) (GSM_StateMachine *s, unsigned char rx_char);
 338         /**
 339          * Protocol initialisation.
 340          */
 341         GSM_Error (*Initialise)   (GSM_StateMachine *s);
 342         /**
 343          * Protocol termination.
 344          */
 345         GSM_Error (*Terminate)    (GSM_StateMachine *s);
 346 } GSM_Protocol_Functions;
 347
 348 #ifdef GSM_ENABLE_MBUS2
 349         extern GSM_Protocol_Functions MBUS2Protocol;
 350 #endif
 351 #if defined(GSM_ENABLE_FBUS2) || defined(GSM_ENABLE_FBUS2IRDA) || defined(GSM_ENABLE_FBUS2DLR3) || defined(GSM_ENABLE_DKU5FBUS2) || defined(GSM_ENABLE_FBUS2BLUE) || defined(GSM_ENABLE_BLUEFBUS2) || defined(GSM_ENABLE_FBUS2PL2303)
 352         extern GSM_Protocol_Functions FBUS2Protocol;
 353 #endif
 354 #if defined(GSM_ENABLE_PHONETBLUE) || defined(GSM_ENABLE_IRDAPHONET) || defined(GSM_ENABLE_BLUEPHONET) || defined(GSM_ENABLE_DKU2PHONET)
 355         extern GSM_Protocol_Functions PHONETProtocol;
 356 #endif
 357 #if defined(GSM_ENABLE_AT) || defined(GSM_ENABLE_BLUEAT) || defined(GSM_ENABLE_IRDAAT) || defined(GSM_ENABLE_DKU2AT)
 358         extern GSM_Protocol_Functions ATProtocol;
 359 #endif
 360 #ifdef GSM_ENABLE_ALCABUS
 361         extern GSM_Protocol_Functions ALCABUSProtocol;
 362 #endif
 363 #if defined(GSM_ENABLE_IRDAOBEX) || defined(GSM_ENABLE_BLUEOBEX) || defined(GSM_ENABLE_ATOBEX)
 364         extern GSM_Protocol_Functions OBEXProtocol;
 365 #endif
 366 #if defined(GSM_ENABLE_BLUEGNAPBUS) || defined(GSM_ENABLE_IRDAGNAPBUS)
 367         extern GSM_Protocol_Functions GNAPBUSProtocol;
 368 #endif
 369 #if defined(GSM_ENABLE_S60)
 370         extern GSM_Protocol_Functions S60Protocol;
 371 #endif
 372
 373 /**
 374  * Structure containing protocol specific data and pointer to protocol
 375  * functions - @ref GSM_Protocol_Functions. The data are in a structure, so
 376  * you may use more protocols at once and switch between them.
 377  */
 378 typedef struct {
 379         struct {
 380                 char fake;
 381 #ifdef GSM_ENABLE_MBUS2
 382                 GSM_Protocol_MBUS2Data          MBUS2;
 383 #endif
 384 #if defined(GSM_ENABLE_FBUS2) || defined(GSM_ENABLE_FBUS2IRDA) || defined(GSM_ENABLE_FBUS2DLR3) || defined(GSM_ENABLE_DKU5FBUS2) || defined(GSM_ENABLE_FBUS2PL2303) || defined(GSM_ENABLE_FBUS2BLUE) || defined(GSM_ENABLE_BLUEFBUS2)
 385                 GSM_Protocol_FBUS2Data          FBUS2;
 386 #endif
 387 #if defined(GSM_ENABLE_PHONETBLUE) || defined(GSM_ENABLE_IRDAPHONET) || defined(GSM_ENABLE_BLUEPHONET) || defined(GSM_ENABLE_DKU2PHONET)
 388                 GSM_Protocol_PHONETData         PHONET;
 389 #endif
 390 #if defined(GSM_ENABLE_AT) || defined(GSM_ENABLE_BLUEAT) || defined(GSM_ENABLE_IRDAAT) || defined(GSM_ENABLE_DKU2AT)
 391                 GSM_Protocol_ATData             AT;
 392 #endif
 393 #ifdef GSM_ENABLE_ALCABUS
 394                 GSM_Protocol_ALCABUSData        ALCABUS;
 395 #endif
 396 #if defined(GSM_ENABLE_IRDAOBEX) || defined(GSM_ENABLE_BLUEOBEX) || defined(GSM_ENABLE_ATOBEX)
 397                 GSM_Protocol_OBEXData           OBEX;
 398 #endif
 399 #if defined(GSM_ENABLE_BLUEGNAPBUS) || defined(GSM_ENABLE_IRDAGNAPBUS)
 400                 GSM_Protocol_GNAPBUSData        GNAPBUS;
 401 #endif
 402 #if defined(GSM_ENABLE_S60)
 403                 GSM_Protocol_S60Data            S60;
 404 #endif
 405         } Data;
 406         /**
 407          * Functions for currently used protocol layer.
 408          */
 409         GSM_Protocol_Functions *Functions;
 410 } GSM_Protocol;
 411
 412 /* -------------------------- Phone layer ---------------------------------- */
 413
 414
 415 /**
 416  * Phone related data are stored here.
 417  */
 418 typedef struct {
 419         /**
 420          * Phone IMEI (or serial number).
 421          */
 422         char                    IMEI[GSM_MAX_IMEI_LENGTH + 1];
 423         /**
 424          * Phone manufacturer as reported by phone.
 425          */
 426         char                    Manufacturer[GSM_MAX_MANUFACTURER_LENGTH + 1];
 427         /**
 428          * Phone model as reported by phone.
 429          */
 430         char                    Model[GSM_MAX_MODEL_LENGTH + 1];
 431         /**
 432          * Model information, pointer to static @ref allmodels array.
 433          */
 434         GSM_PhoneModel          *ModelInfo;
 435         /**
 436          * Phone version as reported by phone. It doesn't have to be numerical
 437          * at all.
 438          */
 439         char                    Version[GSM_MAX_VERSION_LENGTH + 1];
 440         /**
 441          * Phone version date, might be empty for some models.
 442          */
 443         char                    VerDate[GSM_MAX_VERSION_DATE_LENGTH + 1];
 444         /**
 445          * Phone version as number, if applicable.
 446          */
 447         double                  VerNum;
 448         /**
 449          * Cache for hardware version used by some modules.
 450          */
 451         char                    HardwareCache[50];
 452         /**
 453          * Cache for product code version used by some modules.
 454          */
 455         char                    ProductCodeCache[50];
 456
 457         /**
 458          * Counter used for disabling startup info on phone, see
 459          * @ref GSM_Phone_Functions::ShowStartInfo . After this is 0, the startup info is hidden.
 460          */
 461         int                     StartInfoCounter;
 462
 463         /**
 464          * Pointer to structure used internally by phone drivers.
 465          */
 466         GSM_GPRSAccessPoint     *GPRSPoint;
 467         /**
 468          * Pointer to structure used internally by phone drivers.
 469          */
 470         GSM_SpeedDial           *SpeedDial;
 471         /**
 472          * Pointer to structure used internally by phone drivers.
 473          */
 474         GSM_DateTime            *DateTime;
 475         /**
 476          * Pointer to structure used internally by phone drivers.
 477          */
 478         GSM_Alarm               *Alarm;
 479         /**
 480          * Pointer to structure used internally by phone drivers.
 481          */
 482         GSM_MemoryEntry         *Memory;
 483         /**
 484          * Pointer to structure used internally by phone drivers.
 485          */
 486         GSM_MemoryStatus        *MemoryStatus;
 487         /**
 488          * Pointer to structure used internally by phone drivers.
 489          */
 490         GSM_SMSC                *SMSC;
 491         /**
 492          * Pointer to structure used internally by phone drivers.
 493          */
 494         GSM_MultiSMSMessage     *GetSMSMessage;
 495         /**
 496          * Pointer to structure used internally by phone drivers.
 497          */
 498         GSM_SMSMessage          *SaveSMSMessage;
 499         /**
 500          * Pointer to structure used internally by phone drivers.
 501          */
 502         GSM_SMSMemoryStatus     *SMSStatus;
 503         /**
 504          * Pointer to structure used internally by phone drivers.
 505          */
 506         GSM_SMSFolders          *SMSFolders;
 507         /**
 508          * Used internally by phone drivers.
 509          */
 510         size_t                  *VoiceRecord;
 511         /**
 512          * Used internally by phone drivers.
 513          */
 514         int                     CallID;
 515         /**
 516          * Pointer to structure used internally by phone drivers.
 517          */
 518         GSM_SignalQuality       *SignalQuality;
 519         /**
 520          * Pointer to structure used internally by phone drivers.
 521          */
 522         GSM_BatteryCharge       *BatteryCharge;
 523         /**
 524          * Pointer to structure used internally by phone drivers.
 525          */
 526         GSM_NetworkInfo         *NetworkInfo;
 527         /**
 528          * Pointer to structure used internally by phone drivers.
 529          */
 530         GSM_Ringtone            *Ringtone;
 531         /**
 532          * Pointer to structure used internally by phone drivers.
 533          */
 534         GSM_CalendarEntry       *Cal;
 535         /**
 536          * Calendar status.
 537          */
 538         GSM_CalendarStatus      *CalStatus;
 539         /**
 540          * Todo status.
 541          */
 542         GSM_ToDoStatus          *ToDoStatus;
 543         /**
 544          * Used internally by phone drivers.
 545          */
 546         unsigned char           *SecurityCode;
 547         /**
 548          * Pointer to structure used internally by phone drivers.
 549          */
 550         GSM_WAPBookmark         *WAPBookmark;
 551         /**
 552          * Pointer to structure used internally by phone drivers.
 553          */
 554         GSM_MultiWAPSettings    *WAPSettings;
 555         /**
 556          * Pointer to structure used internally by phone drivers.
 557          */
 558         GSM_Bitmap              *Bitmap;
 559         /**
 560          * Used internally by phone drivers.
 561          */
 562         unsigned char           *Netmonitor;
 563         /**
 564          * Pointer to call diversion structure used internally by phone drivers.
 565          */
 566         GSM_MultiCallDivert     *Divert;
 567         /**
 568          * Pointer to todo structure used internally by phone drivers.
 569          */
 570         GSM_ToDoEntry           *ToDo;
 571         /**
 572          * Pointer to note structure used internally by phone drivers.
 573          */
 574         GSM_NoteEntry           *Note;
 575         /**
 576          * Pointer to picture structure used internally by phone drivers.
 577          */
 578         GSM_BinaryPicture       *Picture;
 579         /**
 580          * Used internally by phone drivers.
 581          */
 582         gboolean                        PressKey;
 583         /**
 584          * Pointer to structure used internally by phone drivers.
 585          */
 586         GSM_SecurityCodeType    *SecurityStatus;
 587         /**
 588          * Pointer to structure used internally by phone drivers.
 589          */
 590         GSM_Profile             *Profile;
 591         /**
 592          * Pointer to structure used internally by phone drivers.
 593          */
 594         GSM_AllRingtonesInfo    *RingtonesInfo;
 595         /**
 596          * Pointer to structure used internally by phone drivers.
 597          */
 598         GSM_DisplayFeatures     *DisplayFeatures;
 599         /**
 600          * Pointer to structure used internally by phone drivers.
 601          */
 602         GSM_FMStation           *FMStation;
 603         /**
 604          * Pointer to structure used internally by phone drivers.
 605          */
 606         GSM_Locale              *Locale;
 607         /**
 608          * Pointer to structure used internally by phone drivers.
 609          */
 610         GSM_CalendarSettings    *CalendarSettings;
 611         /**
 612          * Used internally by phone drivers.
 613          */
 614         unsigned char           *PhoneString;
 615         int                     FileHandle;
 616         /**
 617          * Used internally by phone drivers.
 618          */
 619         int                     StartPhoneString;
 620         /**
 621          * Pointer to structure used internally by phone drivers.
 622          */
 623         GSM_File                *FileInfo;
 624         /**
 625          * Pointer to structure used internally by phone drivers.
 626          */
 627         GSM_File                *File;
 628         /**
 629          * Pointer to structure used internally by phone drivers.
 630          */
 631         GSM_FileSystemStatus    *FileSystemStatus;
 632         /**
 633          * Pointer to structure used internally by phone drivers.
 634          */
 635         GSM_ChatSettings        *ChatSettings;
 636         /**
 637          * Pointer to structure used internally by phone drivers.
 638          */
 639         GSM_SyncMLSettings      *SyncMLSettings;
 640
 641         /**
 642          * Should phone notify about incoming calls?
 643          */
 644         gboolean                        EnableIncomingCall;
 645         /**
 646          * Should phone notify about incoming SMSes?
 647          */
 648         gboolean                        EnableIncomingSMS;
 649         /**
 650          * Should phone notify about incoming CBs?
 651          */
 652         gboolean                        EnableIncomingCB;
 653         /**
 654          * Should phone notify about incoming USSDs?
 655          */
 656         gboolean                        EnableIncomingUSSD;
 657
 658         /**
 659          * Last message received from phone.
 660          */
 661         GSM_Protocol_Message    *RequestMsg;
 662         /**
 663          * Last message sent by Gammu.
 664          */
 665         GSM_Protocol_Message    *SentMsg;
 666         /**
 667          * What operation is being performed now, see @ref GSM_Phone_RequestID
 668          * for possible values.
 669          */
 670         GSM_Phone_RequestID     RequestID;
 671         /**
 672          * Error returned by function in phone module.
 673          */
 674         GSM_Error               DispatchError;
 675
 676         /**
 677          * Structure with private phone modules data.
 678          */
 679         struct {
 680 #ifdef GSM_ENABLE_NOKIA3320
 681                 GSM_Phone_N3320Data      N3320;
 682 #endif
 683 #ifdef GSM_ENABLE_NOKIA3650
 684                 GSM_Phone_N3650Data      N3650;
 685 #endif
 686 #ifdef GSM_ENABLE_NOKIA650
 687                 GSM_Phone_N650Data       N650;
 688 #endif
 689 #ifdef GSM_ENABLE_NOKIA6110
 690                 GSM_Phone_N6110Data      N6110;
 691 #endif
 692 #ifdef GSM_ENABLE_NOKIA6510
 693                 GSM_Phone_N6510Data      N6510;
 694 #endif
 695 #ifdef GSM_ENABLE_NOKIA7110
 696                 GSM_Phone_N7110Data      N7110;
 697 #endif
 698 #ifdef GSM_ENABLE_ATGEN
 699                 GSM_Phone_ATGENData      ATGEN;
 700 #endif
 701 #ifdef GSM_ENABLE_ALCATEL
 702                 GSM_Phone_ALCATELData    ALCATEL;
 703 #endif
 704 #ifdef GSM_ENABLE_ATOBEX
 705                 GSM_Phone_ATOBEXData     ATOBEX;
 706 #endif
 707 #ifdef GSM_ENABLE_OBEXGEN
 708                 GSM_Phone_OBEXGENData    OBEXGEN;
 709 #endif
 710 #ifdef GSM_ENABLE_GNAPGEN
 711                 GSM_Phone_GNAPGENData    GNAPGEN;
 712 #endif
 713 #ifdef GSM_ENABLE_S60
 714                 GSM_Phone_S60Data        S60;
 715 #endif
 716                 GSM_Phone_DUMMYData      DUMMY;
 717         } Priv;
 718 } GSM_Phone_Data;
 719
 720 /**
 721  * Structure defining phone functions.
 722  */
 723 typedef struct {
 724         /**
 725          * Names of supported models separated by |. Must contain at least one
 726          * name.
 727          */
 728         const char                      *models;
 729         /**
 730          * Array of reply functions for the phone, see
 731          * @ref GSM_Reply_Function for details about it.
 732          */
 733         GSM_Reply_Function              *ReplyFunctions;
 734         /**
 735          * Installs required applets to the phone.
 736          */
 737         GSM_Error (*Install)            (GSM_StateMachine *s, const char *ExtraPath, gboolean Minimal);
 738         /**
 739          * Initializes phone.
 740          */
 741         GSM_Error (*Initialise)         (GSM_StateMachine *s);
 742         /**
 743          * Terminates phone communication.
 744          */
 745         GSM_Error (*Terminate)          (GSM_StateMachine *s);
 746         /**
 747          * Dispatches messages from phone, at the end it should call
 748          * @ref GSM_DispatchMessage.
 749          */
 750         GSM_Error (*DispatchMessage)    (GSM_StateMachine *s);
 751         /**
 752          * Enables showing information on phone display.
 753          */
 754         GSM_Error (*ShowStartInfo)      (GSM_StateMachine *s, gboolean enable);
 755         /**
 756          * Reads manufacturer from phone.
 757          */
 758         GSM_Error (*GetManufacturer)    (GSM_StateMachine *s);
 759         /**
 760          * Reads model from phone.
 761          */
 762         GSM_Error (*GetModel)           (GSM_StateMachine *s);
 763         /**
 764          * Reads firmware information from phone.
 765          */
 766         GSM_Error (*GetFirmware)        (GSM_StateMachine *s);
 767         /**
 768          * Reads IMEI/serial number from phone.
 769          */
 770         GSM_Error (*GetIMEI)            (GSM_StateMachine *s);
 771         /**
 772          * Gets date and time from phone.
 773          */
 774         GSM_Error (*GetOriginalIMEI)    (GSM_StateMachine *s, char *value);
 775         /**
 776          * Gets month when device was manufactured.
 777          */
 778         GSM_Error (*GetManufactureMonth)(GSM_StateMachine *s, char *value);
 779         /**
 780          * Gets product code of device.
 781          */
 782         GSM_Error (*GetProductCode)     (GSM_StateMachine *s, char *value);
 783         /**
 784          * Gets hardware information about device.
 785          */
 786         GSM_Error (*GetHardware)        (GSM_StateMachine *s, char *value);
 787         /**
 788          * Gets PPM (Post Programmable Memory) info from phone
 789          * (in other words for Nokia get, which language pack is in phone)
 790          */
 791         GSM_Error (*GetPPM)             (GSM_StateMachine *s, char *value);
 792         /**
 793          * Gets SIM IMSI from phone.
 794          */
 795         GSM_Error (*GetSIMIMSI)         (GSM_StateMachine *s, char *IMSI);
 796         /**
 797          * Reads date and time from phone.
 798          */
 799         GSM_Error (*GetDateTime)        (GSM_StateMachine *s, GSM_DateTime *date_time);
 800         /**
 801          * Sets date and time in phone.
 802          */
 803         GSM_Error (*SetDateTime)        (GSM_StateMachine *s, GSM_DateTime *date_time);
 804         /**
 805          * Reads alarm set in phone.
 806          */
 807         GSM_Error (*GetAlarm)           (GSM_StateMachine *s, GSM_Alarm *Alarm);
 808         /**
 809          * Sets alarm in phone.
 810          */
 811         GSM_Error (*SetAlarm)           (GSM_StateMachine *s, GSM_Alarm *Alarm);
 812         /**
 813          * Gets locale from phone.
 814          */
 815         GSM_Error (*GetLocale)          (GSM_StateMachine *s, GSM_Locale *locale);
 816         /**
 817          * Sets locale of phone.
 818          */
 819         GSM_Error (*SetLocale)          (GSM_StateMachine *s, GSM_Locale *locale);
 820         /**
 821          * Emulates key press or key release.
 822          */
 823         GSM_Error (*PressKey)           (GSM_StateMachine *s, GSM_KeyCode Key, gboolean Press);
 824         /**
 825          * Performs phone reset.
 826          */
 827         GSM_Error (*Reset)              (GSM_StateMachine *s, gboolean hard);
 828         /**
 829          * Resets phone settings.
 830          */
 831         GSM_Error (*ResetPhoneSettings) (GSM_StateMachine *s, GSM_ResetSettingsType Type);
 832         /**
 833          * Enters security code (PIN, PUK,...) .
 834          */
 835         GSM_Error (*EnterSecurityCode)  (GSM_StateMachine *s, GSM_SecurityCode *Code);
 836         /**
 837          * Queries whether some security code needs to be entered./
 838          */
 839         GSM_Error (*GetSecurityStatus)  (GSM_StateMachine *s, GSM_SecurityCodeType *Status);
 840         /**
 841          * Acquired display status.
 842          */
 843         GSM_Error (*GetDisplayStatus)   (GSM_StateMachine *s, GSM_DisplayFeatures *features);
 844         /**
 845          * Enables network auto login.
 846          */
 847         GSM_Error (*SetAutoNetworkLogin)(GSM_StateMachine *s);
 848         /**
 849          * Gets information about batery charge and phone charging state.
 850          */
 851         GSM_Error (*GetBatteryCharge)   (GSM_StateMachine *s, GSM_BatteryCharge *bat);
 852         /**
 853          * Reads signal quality (strength and error rate).
 854          */
 855         GSM_Error (*GetSignalQuality)   (GSM_StateMachine *s, GSM_SignalQuality *sig);
 856         /**
 857          * Gets network information.
 858          */
 859         GSM_Error (*GetNetworkInfo)     (GSM_StateMachine *s, GSM_NetworkInfo *netinfo);
 860         /**
 861          * Reads category from phone.
 862          */
 863         GSM_Error (*GetCategory)        (GSM_StateMachine *s, GSM_Category *Category);
 864         /**
 865          * Adds category to phone.
 866          */
 867         GSM_Error (*AddCategory)        (GSM_StateMachine *s, GSM_Category *Category);
 868         /**
 869          * Reads category status (number of used entries) from phone.
 870          */
 871         GSM_Error (*GetCategoryStatus)  (GSM_StateMachine *s, GSM_CategoryStatus *Status);
 872         /**
 873          * Gets memory (phonebooks or calls) status (eg. number of used and
 874          * free entries).
 875          */
 876         GSM_Error (*GetMemoryStatus)    (GSM_StateMachine *s, GSM_MemoryStatus *status);
 877         /**
 878          * Reads entry from memory (phonebooks or calls). Which entry should
 879          * be read is defined in entry.
 880          */
 881         GSM_Error (*GetMemory)          (GSM_StateMachine *s, GSM_MemoryEntry *entry);
 882         /**
 883          * Reads entry from memory (phonebooks or calls). Which entry should
 884          * be read is defined in entry. This can be easily used for reading all entries.
 885          */
 886         GSM_Error (*GetNextMemory)      (GSM_StateMachine *s, GSM_MemoryEntry *entry, gboolean start);
 887         /**
 888          * Sets memory (phonebooks or calls) entry.
 889          */
 890         GSM_Error (*SetMemory)          (GSM_StateMachine *s, GSM_MemoryEntry *entry);
 891         /**
 892          * Deletes memory (phonebooks or calls) entry.
 893          */
 894         GSM_Error (*AddMemory)          (GSM_StateMachine *s, GSM_MemoryEntry *entry);
 895         /**
 896          * Deletes memory (phonebooks or calls) entry.
 897          */
 898         GSM_Error (*DeleteMemory)       (GSM_StateMachine *s, GSM_MemoryEntry *entry);
 899         /**
 900          * Deletes all memory (phonebooks or calls) entries of specified type.
 901          */
 902         GSM_Error (*DeleteAllMemory)    (GSM_StateMachine *s, GSM_MemoryType MemoryType);
 903         /**
 904          * Gets speed dial.
 905          */
 906         GSM_Error (*GetSpeedDial)       (GSM_StateMachine *s, GSM_SpeedDial *Speed);
 907         /**
 908          * Sets speed dial.
 909          */
 910         GSM_Error (*SetSpeedDial)       (GSM_StateMachine *s, GSM_SpeedDial *Speed);
 911         /**
 912          * Gets SMS Service Center number and SMS settings.
 913          */
 914         GSM_Error (*GetSMSC)            (GSM_StateMachine *s, GSM_SMSC *smsc);
 915         /**
 916          * Sets SMS Service Center number and SMS settings.
 917          */
 918         GSM_Error (*SetSMSC)            (GSM_StateMachine *s, GSM_SMSC *smsc);
 919         /**
 920          * Gets information about SMS memory (read/unread/size of memory for
 921          * both SIM and phone).
 922          */
 923         GSM_Error (*GetSMSStatus)       (GSM_StateMachine *s, GSM_SMSMemoryStatus *status);
 924         /**
 925          * Reads SMS message.
 926          */
 927         GSM_Error (*GetSMS)             (GSM_StateMachine *s, GSM_MultiSMSMessage *sms);
 928         /**
 929          * Reads next (or first if start set) SMS message. This might be
 930          * faster for some phones than using @ref GetSMS for each message.
 931          */
 932         GSM_Error (*GetNextSMS)         (GSM_StateMachine *s, GSM_MultiSMSMessage *sms, gboolean start);
 933         /**
 934          * Sets SMS.
 935          */
 936         GSM_Error (*SetSMS)             (GSM_StateMachine *s, GSM_SMSMessage *sms);
 937         /**
 938          * Adds SMS to specified folder.
 939          */
 940         GSM_Error (*AddSMS)             (GSM_StateMachine *s, GSM_SMSMessage *sms);
 941         /**
 942          * Deletes SMS.
 943          */
 944         GSM_Error (*DeleteSMS)          (GSM_StateMachine *s, GSM_SMSMessage *sms);
 945         /**
 946          * Sends SMS.
 947          */
 948         GSM_Error (*SendSMS)            (GSM_StateMachine *s, GSM_SMSMessage *sms);
 949         /**
 950          * Sends SMS already saved in phone.
 951          */
 952         GSM_Error (*SendSavedSMS)       (GSM_StateMachine *s, int Folder, int Location);
 953         /**
 954          * Configures fast SMS sending.
 955          */
 956         GSM_Error (*SetFastSMSSending)  (GSM_StateMachine *s, gboolean enable);
 957         /**
 958          * Enable/disable notification on incoming SMS.
 959          */
 960         GSM_Error (*SetIncomingSMS)     (GSM_StateMachine *s, gboolean enable);
 961         /**
 962          * Gets network information from phone.
 963          */
 964         GSM_Error (*SetIncomingCB)      (GSM_StateMachine *s, gboolean enable);
 965         /**
 966          * Returns SMS folders information.
 967          */
 968         GSM_Error (*GetSMSFolders)      (GSM_StateMachine *s, GSM_SMSFolders *folders);
 969         /**
 970          * Creates SMS folder.
 971          */
 972         GSM_Error (*AddSMSFolder)       (GSM_StateMachine *s, unsigned char *name);
 973         /**
 974          * Deletes SMS folder.
 975          */
 976         GSM_Error (*DeleteSMSFolder)    (GSM_StateMachine *s, int ID);
 977         /**
 978          * Dials number and starts voice call.
 979          */
 980         GSM_Error (*DialVoice)          (GSM_StateMachine *s, char *Number, GSM_CallShowNumber ShowNumber);
 981         /**
 982          * Dials service number (usually for USSD).
 983          */
 984         GSM_Error (*DialService)        (GSM_StateMachine *s, char *Number);
 985         /**
 986          * Accept current incoming call.
 987          */
 988         GSM_Error (*AnswerCall)         (GSM_StateMachine *s, int ID, gboolean all);
 989         /**
 990          * Deny current incoming call.
 991          */
 992         GSM_Error (*CancelCall)         (GSM_StateMachine *s, int ID, gboolean all);
 993         /**
 994          * Holds call.
 995          */
 996         GSM_Error (*HoldCall)           (GSM_StateMachine *s, int ID);
 997         /**
 998          * Unholds call.
 999          */
1000         GSM_Error (*UnholdCall)         (GSM_StateMachine *s, int ID);
1001         /**
1002          * Initiates conference call.
1003          */
1004         GSM_Error (*ConferenceCall)     (GSM_StateMachine *s, int ID);
1005         /**
1006          * Splits call.
1007          */
1008         GSM_Error (*SplitCall)          (GSM_StateMachine *s, int ID);
1009         /**
1010          * Transfers call.
1011          */
1012         GSM_Error (*TransferCall)       (GSM_StateMachine *s, int ID, gboolean next);
1013         /**
1014          * Switches call.
1015          */
1016         GSM_Error (*SwitchCall)         (GSM_StateMachine *s, int ID, gboolean next);
1017         /**
1018          * Gets call diverts.
1019          */
1020         GSM_Error (*GetCallDivert)      (GSM_StateMachine *s, GSM_CallDivert *request, GSM_MultiCallDivert *result);
1021         /**
1022          * Sets call diverts.
1023          */
1024         GSM_Error (*SetCallDivert)      (GSM_StateMachine *s, GSM_CallDivert *divert);
1025         /**
1026          * Cancels all diverts.
1027          */
1028         GSM_Error (*CancelAllDiverts)   (GSM_StateMachine *s);
1029         /**
1030          * Activates/deactivates noticing about incoming calls.
1031          */
1032         GSM_Error (*SetIncomingCall)    (GSM_StateMachine *s, gboolean enable);
1033         /**
1034          * Activates/deactivates noticing about incoming USSDs (UnStructured Supplementary Services).
1035          */
1036         GSM_Error (*SetIncomingUSSD)    (GSM_StateMachine *s, gboolean enable);
1037         /**
1038          * Sends DTMF (Dual Tone Multi Frequency) tone.
1039          */
1040         GSM_Error (*SendDTMF)           (GSM_StateMachine *s, char *sequence);
1041         /**
1042          * Gets ringtone from phone.
1043          */
1044         GSM_Error (*GetRingtone)        (GSM_StateMachine *s, GSM_Ringtone *Ringtone, gboolean PhoneRingtone);
1045         /**
1046          * Sets ringtone in phone.
1047          */
1048         GSM_Error (*SetRingtone)        (GSM_StateMachine *s, GSM_Ringtone *Ringtone, int *maxlength);
1049         /**
1050          * Acquires ringtone informaiton.
1051          */
1052         GSM_Error (*GetRingtonesInfo)   (GSM_StateMachine *s, GSM_AllRingtonesInfo *Info);
1053         /**
1054          * Deletes user defined ringtones from phone.
1055          */
1056         GSM_Error (*DeleteUserRingtones)(GSM_StateMachine *s);
1057         /**
1058          * Plays tone.
1059          */
1060         GSM_Error (*PlayTone)           (GSM_StateMachine *s, int Herz, unsigned char Volume, gboolean start);
1061         /**
1062          * Reads WAP bookmark.
1063          */
1064         GSM_Error (*GetWAPBookmark)     (GSM_StateMachine *s, GSM_WAPBookmark *bookmark);
1065         /**
1066          * Sets WAP bookmark.
1067          */
1068         GSM_Error (*SetWAPBookmark)     (GSM_StateMachine *s, GSM_WAPBookmark *bookmark);
1069         /**
1070          * Deletes WAP bookmark.
1071          */
1072         GSM_Error (*DeleteWAPBookmark)  (GSM_StateMachine *s, GSM_WAPBookmark *bookmark);
1073         /**
1074          * Acquires WAP settings.
1075          */
1076         GSM_Error (*GetWAPSettings)     (GSM_StateMachine *s, GSM_MultiWAPSettings *settings);
1077         /**
1078          * Changes WAP settings.
1079          */
1080         GSM_Error (*SetWAPSettings)     (GSM_StateMachine *s, GSM_MultiWAPSettings *settings);
1081         /**
1082          * Acquires SyncML settings.
1083          */
1084         GSM_Error (*GetSyncMLSettings)  (GSM_StateMachine *s, GSM_SyncMLSettings *settings);
1085         /**
1086          * Changes SyncML settings.
1087          */
1088         GSM_Error (*SetSyncMLSettings)  (GSM_StateMachine *s, GSM_SyncMLSettings *settings);
1089         /**
1090          * Acquires chat/presence settings.
1091          */
1092         GSM_Error (*GetChatSettings)    (GSM_StateMachine *s, GSM_ChatSettings *settings);
1093         /**
1094          * Changes chat/presence settings.
1095          */
1096         GSM_Error (*SetChatSettings)    (GSM_StateMachine *s, GSM_ChatSettings *settings);
1097         /**
1098          * Acquires MMS settings.
1099          */
1100         GSM_Error (*GetMMSSettings)     (GSM_StateMachine *s, GSM_MultiWAPSettings *settings);
1101         /**
1102          * Changes MMS settings.
1103          */
1104         GSM_Error (*SetMMSSettings)     (GSM_StateMachine *s, GSM_MultiWAPSettings *settings);
1105         /**
1106          * Lists MMS folders.
1107          */
1108         GSM_Error (*GetMMSFolders)      (GSM_StateMachine *s, GSM_MMSFolders *folders);
1109         /**
1110          * Retrieves next part of MMS file information.
1111          */
1112         GSM_Error (*GetNextMMSFileInfo) (GSM_StateMachine *s, unsigned char *FileID, int *MMSFolder, gboolean start);
1113         /**
1114          * Gets bitmap.
1115          */
1116         GSM_Error (*GetBitmap)          (GSM_StateMachine *s, GSM_Bitmap *Bitmap);
1117         /**
1118          * Sets bitmap.
1119          */
1120         GSM_Error (*SetBitmap)          (GSM_StateMachine *s, GSM_Bitmap *Bitmap);
1121         /**
1122          * Gets status of ToDos (count of used entries).
1123          */
1124         GSM_Error (*GetToDoStatus)      (GSM_StateMachine *s, GSM_ToDoStatus *status);
1125         /**
1126          * Reads ToDo from phone.
1127          */
1128         GSM_Error (*GetToDo)            (GSM_StateMachine *s, GSM_ToDoEntry *ToDo);
1129         /**
1130          * Reads ToDo from phone.
1131          */
1132         GSM_Error (*GetNextToDo)        (GSM_StateMachine *s, GSM_ToDoEntry *ToDo, gboolean start);
1133         /**
1134          * Sets ToDo in phone.
1135          */
1136         GSM_Error (*SetToDo)            (GSM_StateMachine *s, GSM_ToDoEntry *ToDo);
1137         /**
1138          * Adds ToDo in phone.
1139          */
1140         GSM_Error (*AddToDo)            (GSM_StateMachine *s, GSM_ToDoEntry *ToDo);
1141         /**
1142          * Deletes ToDo entry in phone.
1143          */
1144         GSM_Error (*DeleteToDo)         (GSM_StateMachine *s, GSM_ToDoEntry *ToDo);
1145         /**
1146          * Deletes all todo entries in phone.
1147          */
1148         GSM_Error (*DeleteAllToDo)      (GSM_StateMachine *s);
1149         /**
1150          * Retrieves calendar status (number of used entries).
1151          */
1152         GSM_Error (*GetCalendarStatus)  (GSM_StateMachine *s, GSM_CalendarStatus *Status);
1153         /**
1154          * Retrieves calendar entry.
1155          */
1156         GSM_Error (*GetCalendar)        (GSM_StateMachine *s, GSM_CalendarEntry *Note);
1157         /**
1158          * Retrieves calendar entry. This is useful for continuous reading of all
1159          * calendar entries.
1160          */
1161         GSM_Error (*GetNextCalendar)    (GSM_StateMachine *s, GSM_CalendarEntry *Note, gboolean start);
1162         /**
1163          * Sets calendar entry
1164          */
1165         GSM_Error (*SetCalendar)        (GSM_StateMachine *s, GSM_CalendarEntry *Note);
1166         /**
1167          * Adds calendar entry.
1168          */
1169         GSM_Error (*AddCalendar)        (GSM_StateMachine *s, GSM_CalendarEntry *Note);
1170         /**
1171          * Deletes calendar entry.
1172          */
1173         GSM_Error (*DeleteCalendar)     (GSM_StateMachine *s, GSM_CalendarEntry *Note);
1174         /**
1175          * Deletes all calendar entries.
1176          */
1177         GSM_Error (*DeleteAllCalendar)  (GSM_StateMachine *s);
1178         /**
1179          * Reads calendar settings.
1180          */
1181         GSM_Error (*GetCalendarSettings)(GSM_StateMachine *s, GSM_CalendarSettings *settings);
1182         /**
1183          * Sets calendar settings.
1184          */
1185         GSM_Error (*SetCalendarSettings)(GSM_StateMachine *s, GSM_CalendarSettings *settings);
1186         /**
1187          * Retrieves notes status (number of used entries).
1188          */
1189         GSM_Error (*GetNotesStatus)     (GSM_StateMachine *s, GSM_ToDoStatus *status);
1190         /**
1191          * Retrieves notes entry.
1192          */
1193         GSM_Error (*GetNote)            (GSM_StateMachine *s, GSM_NoteEntry *Note);
1194         /**
1195          * Retrieves note entry. This is useful for continuous reading of all
1196          * notes entries.
1197          */
1198         GSM_Error (*GetNextNote)        (GSM_StateMachine *s, GSM_NoteEntry *Note, gboolean start);
1199         /**
1200          * Sets note entry
1201          */
1202         GSM_Error (*SetNote)            (GSM_StateMachine *s, GSM_NoteEntry *Note);
1203         /**
1204          * Adds note entry.
1205          */
1206         GSM_Error (*AddNote)            (GSM_StateMachine *s, GSM_NoteEntry *Note);
1207         /**
1208          * Deletes note entry.
1209          */
1210         GSM_Error (*DeleteNote)         (GSM_StateMachine *s, GSM_NoteEntry *Note);
1211         /**
1212          * Deletes all notes entries.
1213          */
1214         GSM_Error (*DeleteAllNotes)     (GSM_StateMachine *s);
1215         /**
1216          * Reads profile.
1217          */
1218         GSM_Error (*GetProfile)         (GSM_StateMachine *s, GSM_Profile *Profile);
1219         /**
1220          * Updates profile.
1221          */
1222         GSM_Error (*SetProfile)         (GSM_StateMachine *s, GSM_Profile *Profile);
1223         /**
1224          * Reads FM station.
1225          */
1226         GSM_Error (*GetFMStation)       (GSM_StateMachine *s, GSM_FMStation *FMStation);
1227         /**
1228          * Sets FM station.
1229          */
1230         GSM_Error (*SetFMStation)       (GSM_StateMachine *s, GSM_FMStation *FMStation);
1231         /**
1232          * Clears defined FM stations.
1233          */
1234         GSM_Error (*ClearFMStations)    (GSM_StateMachine *s);
1235         /**
1236          * Gets next filename from filesystem.
1237          */
1238         GSM_Error (*GetNextFileFolder)  (GSM_StateMachine *s, GSM_File *File, gboolean start);
1239         /**
1240          * Gets file part from filesystem.
1241          */
1242         GSM_Error (*GetFolderListing)   (GSM_StateMachine *s, GSM_File *File, gboolean start);
1243         /**
1244          * Gets next root folder.
1245          */
1246         GSM_Error (*GetNextRootFolder)  (GSM_StateMachine *s, GSM_File *File);
1247         /**
1248          * Sets file system attributes.
1249          */
1250         GSM_Error (*SetFileAttributes)  (GSM_StateMachine *s, GSM_File *File);
1251         /**
1252          * Retrieves file part.
1253          */
1254         GSM_Error (*GetFilePart)        (GSM_StateMachine *s, GSM_File *File, int *Handle, int *Size);
1255         /**
1256          * Adds file part to filesystem.
1257          */
1258         GSM_Error (*AddFilePart)        (GSM_StateMachine *s, GSM_File *File, int *Pos, int *Handle);
1259         /**
1260          * Sends file to phone, it's up to phone to decide what to do with it.
1261          */
1262         GSM_Error (*SendFilePart)       (GSM_StateMachine *s, GSM_File *File, int *Pos, int *Handle);
1263         /**
1264          * Acquires filesystem status.
1265          */
1266         GSM_Error (*GetFileSystemStatus)(GSM_StateMachine *s, GSM_FileSystemStatus *Status);
1267         /**
1268          * Deletes file from filessytem.
1269          */
1270         GSM_Error (*DeleteFile)         (GSM_StateMachine *s, unsigned char *ID);
1271         /**
1272          * Adds folder to filesystem.
1273          */
1274         GSM_Error (*AddFolder)          (GSM_StateMachine *s, GSM_File *File);
1275         /**
1276          * Deletes folder from filesystem.
1277          */
1278         GSM_Error (*DeleteFolder)       (GSM_StateMachine *s, unsigned char *ID);
1279         /**
1280          * Gets GPRS access point.
1281          */
1282         GSM_Error (*GetGPRSAccessPoint) (GSM_StateMachine *s, GSM_GPRSAccessPoint *point);
1283         /**
1284          * Sets GPRS access point.
1285          */
1286         GSM_Error (*SetGPRSAccessPoint) (GSM_StateMachine *s, GSM_GPRSAccessPoint *point);
1287         /**
1288          * Gets phone screenshot
1289          */
1290         GSM_Error (*GetScreenshot)      (GSM_StateMachine *s, GSM_BinaryPicture *picture);
1291 } GSM_Phone_Functions;
1292
1293         extern GSM_Phone_Functions NAUTOPhone;
1294 #ifdef GSM_ENABLE_NOKIA3320
1295         extern GSM_Phone_Functions N3320Phone;
1296 #endif
1297 #ifdef GSM_ENABLE_NOKIA3650
1298         extern GSM_Phone_Functions N3650Phone;
1299 #endif
1300 #ifdef GSM_ENABLE_NOKIA6110
1301         extern GSM_Phone_Functions N6110Phone;
1302 #endif
1303 #ifdef GSM_ENABLE_NOKIA650
1304         extern GSM_Phone_Functions N650Phone;
1305 #endif
1306 #ifdef GSM_ENABLE_NOKIA6510
1307         extern GSM_Phone_Functions N6510Phone;
1308 #endif
1309 #ifdef GSM_ENABLE_NOKIA7110
1310         extern GSM_Phone_Functions N7110Phone;
1311 #endif
1312 #ifdef GSM_ENABLE_NOKIA9210
1313         extern GSM_Phone_Functions N9210Phone;
1314 #endif
1315 #ifdef GSM_ENABLE_ATGEN
1316         extern GSM_Phone_Functions ATGENPhone;
1317 #endif
1318 #ifdef GSM_ENABLE_ALCATEL
1319         extern GSM_Phone_Functions ALCATELPhone;
1320 #endif
1321 #ifdef GSM_ENABLE_ATOBEX
1322         extern GSM_Phone_Functions ATOBEXPhone;
1323 #endif
1324 #ifdef GSM_ENABLE_OBEXGEN
1325         extern GSM_Phone_Functions OBEXGENPhone;
1326 #endif
1327 #ifdef GSM_ENABLE_GNAPGEN
1328         extern GSM_Phone_Functions GNAPGENPhone;
1329 #endif
1330 #ifdef GSM_ENABLE_S60
1331         extern GSM_Phone_Functions S60Phone;
1332 #endif
1333         extern GSM_Phone_Functions DUMMYPhone;
1334
1335 /**
1336  * Phone functions and private data.
1337  */
1338 typedef struct {
1339         /**
1340          * Private data for current phone driver.
1341          */
1342         GSM_Phone_Data           Data;
1343         /**
1344          * Functions for current phone driver.
1345          */
1346         GSM_Phone_Functions     *Functions;
1347 } GSM_Phone;
1348
1349 /* --------------------------- User layer ---------------------------------- */
1350
1351 struct _GSM_User {
1352         GSM_Reply_Function              *UserReplyFunctions;
1353
1354         IncomingCallCallback IncomingCall;
1355         IncomingSMSCallback IncomingSMS;
1356         IncomingCBCallback IncomingCB;
1357         IncomingUSSDCallback IncomingUSSD;
1358         SendSMSStatusCallback SendSMSStatus;
1359         void * IncomingCallUserData;
1360         void * IncomingSMSUserData;
1361         void * IncomingCBUserData;
1362         void * IncomingUSSDUserData;
1363         void * SendSMSStatusUserData;
1364 };
1365
1366 /* --------------------------- Statemachine layer -------------------------- */
1367
1368
1369 /**
1370  * Maximum number of concurrent configurations.
1371  */
1372 #define MAX_CONFIG_NUM          5
1373
1374 struct _GSM_StateMachine {
1375         GSM_ConnectionType      ConnectionType;                         /**< Type of connection as int                  */
1376         /**
1377          * Skip lowlevel serial handling, cable is known to be broken.
1378          */
1379         gboolean                        SkipDtrRts;
1380         /**
1381          * Do not give power supply to cable on DTR/RTS signals.
1382          */
1383         gboolean                        NoPowerCable;
1384         char                    *LockFile;                              /**< Lock file name for Unix                    */
1385         GSM_Debug_Info          di;                                     /**< Debug information                          */
1386         gboolean                        opened;                                 /**< Is connection opened ?                     */
1387         GSM_Config              Config[MAX_CONFIG_NUM + 1];             /**< Configuration data */
1388         GSM_Config              *CurrentConfig;                         /**< Config file (or Registry or...) variables  */
1389         int                     ConfigNum;                              /**< Number of actual configurations */
1390         int                     ReplyNum;                               /**< How many times make sth.                   */
1391         int                     Speed;                                  /**< For some protocols used speed              */
1392
1393         /**
1394          * Flag for interrupting communication.
1395          */
1396         volatile gboolean Abort;
1397
1398         GSM_Device              Device; /**< Device driver data and functions */
1399         GSM_Protocol            Protocol; /**< Protocol driver data and functions */
1400         GSM_Phone               Phone; /**< Phone driver data and functions */
1401         GSM_User                User; /**< User defined functions */
1402 };
1403
1404 /* ------------------------ Other general definitions ---------------------- */
1405
1406 /**
1407  * Tries to register all modules to find one matching current configuration.
1408  *
1409  * \param s State machine pointer.
1410  *
1411  * \return Error code, ERR_NONE on success.
1412  */
1413 GSM_Error GSM_RegisterAllPhoneModules   (GSM_StateMachine *s);
1414
1415 GSM_Error GSM_WaitForOnce               (GSM_StateMachine *s, unsigned const char *buffer,
1416                                          int length, int type, int timeout);
1417
1418 /**
1419  * Wait for reply from the phone.
1420  *
1421  * \param s State machine pointer.
1422  * \param buffer Data to write to phone.
1423  * \param length Length of data in buffer.
1424  * \param type Type of request (for protocols where it makes sense).
1425  * \param timeout How long to wait for reply.
1426  * \param request ID of request
1427  *
1428  * \return Error code, ERR_NONE on sucecss.
1429  */
1430 GSM_Error GSM_WaitFor                   (GSM_StateMachine *s, unsigned const char *buffer,
1431                                          int length, int type, int timeout,
1432                                          GSM_Phone_RequestID request) WARNUNUSED;
1433
1434 /**
1435  * Wait for reply from the phone for ASCII strings without given length.
1436  * This is just a convenience wrapper around GSM_WaitFor which fills in
1437  * length.
1438  *
1439  * \param s State machine pointer.
1440  * \param buffer Data to write to phone.
1441  * \param type Type of request (for protocols where it makes sense).
1442  * \param timeout How long to wait for reply.
1443  * \param request ID of request
1444  *
1445  * \return Error code, ERR_NONE on sucecss.
1446  */
1447 #define GSM_WaitForAutoLen(s,buffer,type,timeout,request) \
1448         GSM_WaitFor(s,buffer,strlen(buffer),type,timeout,request)
1449
1450 GSM_Error GSM_DispatchMessage           (GSM_StateMachine *s);
1451
1452 void      GSM_DumpMessageLevel2         (GSM_StateMachine *s, unsigned const char *message, int messagesize, int type);
1453 void      GSM_DumpMessageLevel2Recv     (GSM_StateMachine *s, unsigned const char *message, int messagesize, int type);
1454 void      GSM_DumpMessageLevel3         (GSM_StateMachine *s, unsigned const char *message, int messagesize, int type);
1455 void GSM_DumpMessageLevel3Recv(GSM_StateMachine *s, unsigned const char *message, int messagesize, int type);
1456
1457
1458 void GSM_OSErrorInfo(GSM_StateMachine *s, const char *description);
1459
1460 #endif
1461 /*@}*/
1462
1463 /* How should editor hadle tabs in this file? Add editor commands here.
1464  * vim: noexpandtab sw=8 ts=8 sts=8:
1465  */