alcatel.h

Go to the documentation of this file.

/* (c) 2002-2004 by Michal Cihar */

/*
 * High level functions for communication with Alcatel One Touch 501 and
 * compatible mobile phone.
 *
 * This code implements functions to communicate with Alcatel phones,
 * currently seem to work:
 *  - BE5 series (501/701)
 *  - BF5 series (715)
 *  - BH4 series (535/735)
 * For some functions it uses normal AT  mode (not implemented here, look at
 * ../at/atgen.[ch]) for others it  switches into binary mode and initialises
 * underlaying protocol (see ../../protocol/alcatel/alcabus.[ch]) and
 * communicates over it. Don't ask me why Alcatel uses such silly thing...
 */

#ifndef alcatel_h
#define alcatel_h

#include <gammu-limits.h>
#include <gammu-category.h>

#ifndef GSM_USED_AT
# define GSM_USED_AT
#endif
#ifndef GSM_USED_ALCABUS
# define GSM_USED_ALCABUS
#endif

typedef enum {
        ModeAT = 1,
        ModeBinary
} GSM_Alcatel_Mode;

typedef enum {
        V_1_0 = 1,
        V_1_1
} GSM_Alcatel_ProtocolVersion;

typedef enum {
        StateAttached = 1,
        StateSession,
        StateEdit
} GSM_Alcatel_BinaryState;

typedef enum {
        TypeCalendar = 1,
        TypeContacts,
        TypeToDo
} GSM_Alcatel_BinaryType;

typedef enum {
        Alcatel_date,
        Alcatel_time,
        Alcatel_string, /* char */
        Alcatel_phone,
        Alcatel_enum,
        Alcatel_bool,
        Alcatel_int,
        Alcatel_byte
} GSM_Alcatel_FieldType;

#define ALCATEL_FREE_MEMORY             100

/* There COULD be 0xffffffff on next line, but this is IMHO enough */
#define ALCATEL_MAX_LOCATION            0xffff

#define ALCATEL_MAX_CATEGORIES          100

typedef struct {
        /***********************************/
        /* Communication state information */
        /***********************************/
        GSM_Alcatel_Mode        Mode;
        GSM_Alcatel_BinaryState BinaryState;
        GSM_Alcatel_BinaryType  BinaryType;
        int                     BinaryItem;
        GSM_Alcatel_ProtocolVersion     ProtocolVersion;

        /*****************/
        /* Return values */
        /*****************/
        int                     CommitedRecord;
        gboolean                        TransferCompleted;
        GSM_Alcatel_FieldType   ReturnType;
        GSM_DateTime            ReturnDateTime;
        unsigned int            ReturnInt;
        unsigned char           ReturnString[(GSM_PHONEBOOK_TEXT_LENGTH+1)*2];

        /***********/
        /* Caches: */
        /***********/
        /* Listings of available items for each type */
        int                     **CurrentList;
        int                     *CurrentCount;
        int                     *CalendarItems;
        int                     *ToDoItems;
        int                     *ContactsItems;
        int                     CalendarItemsCount;
        int                     ToDoItemsCount;
        int                     ContactsItemsCount;
        int                     CurrentFields[GSM_PHONEBOOK_ENTRIES+1];
        int                     CurrentFieldsCount;
        int                     CurrentFieldsItem;
        GSM_Alcatel_BinaryType  CurrentFieldsType;

        int                     CurrentCategories[ALCATEL_MAX_CATEGORIES+1];
        char                    CurrentCategoriesCache[ALCATEL_MAX_CATEGORIES+1][(GSM_MAX_CATEGORY_NAME_LENGTH + 1)*2];
        int                     CurrentCategoriesCount;
        GSM_Alcatel_BinaryType  CurrentCategoriesType;

} GSM_Phone_ALCATELData;
#endif


/* How should editor hadle tabs in this file? Add editor commands here.
 * vim: noexpandtab sw=8 ts=8 sts=8:
 */