Gsmd/document

From Openmoko

Revision as of 13:52, 8 October 2007 by Erin Yueh (Talk | contribs)

Jump to: navigation, search

Contents

Overview

What is gsmd

Gsmd is a daemon that handles the communication between applications and GSM modem. Applications control gsmd through libgsmd. libgsmd communicates with gsmd through unix socket, and modem goes through Uart. The diagram is as following.

http://lh6.google.com/ticktock35/RwDCAWdUPEI/AAAAAAAAAD4/wBrRLv-1oyE/s400/gsmd_overview.jpg

Gsmd

GSMD is a event driven daemon. Each event shall has a response. Every event will pass through the gsmd_select_main() in which finding and executing their correspond call back functions.

The last part of gsmd main function enters a infinite loop, trying to call gsmd_select_main.

while(1) {
         int ret = gsmd_select_main();
         ...
 }

gsmd_select_main()

gsmd_select_main this is core of the call back function scheme. All devices, gsmd monitors and linked in a list, are described as a struct gsmd_fd, and gsmd_select_main will select them. Once an event comes out from one of the devices, gsmd_select_main will try to call it's call back function that devices registered.

int gsmd_select_main()
{
       struct gsmd_fd *ufd, *ufd2;
       fd_set readset, writeset, exceptset;
       int i;

       FD_ZERO(&readset);
       FD_ZERO(&writeset);
       FD_ZERO(&exceptset);

       /* prepare read and write fdsets */
       llist_for_each_entry(ufd, &gsmd_fds, list) {
               if (ufd->when & GSMD_FD_READ)
                       FD_SET(ufd->fd, &readset);

               if (ufd->when & GSMD_FD_WRITE)
                       FD_SET(ufd->fd, &writeset);

               if (ufd->when & GSMD_FD_EXCEPT)
                       FD_SET(ufd->fd, &exceptset);
       }

       i = select(maxfd+1, &readset, &writeset, &exceptset, NULL);
       if (i > 0) {
               /* call registered callback functions */
               llist_for_each_entry_safe(ufd, ufd2, &gsmd_fds, list) {
                       int flags = 0;

                       if (FD_ISSET(ufd->fd, &readset))
                               flags |= GSMD_FD_READ;

                       if (FD_ISSET(ufd->fd, &writeset))
                               flags |= GSMD_FD_WRITE;
 
                       if (FD_ISSET(ufd->fd, &exceptset))
                               flags |= GSMD_FD_EXCEPT;

                       if (flags)
                               ufd->cb(ufd->fd, flags, ufd->data);
               }
       }
       return i;
}


gsmd_fd

struct gsmd_fd {
    struct llist_head list;
    int fd;                         /* file descriptor */
    unsigned int when;
    int (*cb)(int fd, unsigned int what, void *data);
    void *data;                     /* void * to pass to callback */
};

When there are anything change in fd, the gsmd_select_main will detect them and try to call it's call back function cb.

That means if you redirect the cb to another implementation, the gsmd will behave very differently.

gsmd_atcmd

struct gsmd_atcmd {
       struct llist_head list;
       void *ctx;
       int (*cb)(struct gsmd_atcmd *cmd, void *ctx, char *resp);
       char *resp;
       int32_t ret;
       u_int32_t buflen;
       u_int16_t id;
       u_int8_t flags;
       char *cur;
       char buf[];
};

call back functions

Gsmd opens at least one devices. One is uart to modem and others are the Unix socket, communicating with libgsmd.

atcmd_select_cb is the default call back function that dealing the uart to the modem. It will handle sending AT command to modem or receive whatever return from modem and send them into parser.

The default parser call back function of uart (to modem) is ml_parse, in which dealing with reading the response of modem dispatch the correct call back function to handle the response.

atcmd_select_cb

atcmd_fill
atcmd_submit

ml_parse

ml_parse is the parser call back function that handles:

  • Initial GSM Modem
  • handle correspond AT command call back
  • handle notification call back
initial GSM Modem

When the modem firmware is ready to initial, it will send AT-Command Interpreter ready to gsmd. If ml_parse get this string, gsmd will try to initialize the modem.

       if (strlen(buf) == 0 ||
           !strcmp(buf, "AT-Command Interpreter ready")) {
               g->interpreter_ready = 1;
               gsmd_initsettings(g);
               gmsd_alive_start(g);
               return 0;
       }

What modem write to gsmd will put in "buf". And if the contents of the "buf" is "AT-Command Interpreter ready" the automatic gsmd initialize will start.

gsmd_alive_start is a scheme that gsmd detect if the modem is still alive or not. It will send an "AT" to modem periodically, and check the modem's response.

handle correspond AT command call back
handle notification call back

libgsmd

libgsmd is a library with C language API for application programs. Programs using this library can use the phone, e.g. make phone calls, receive incoming calls, register to the network, etc.

libgsmd_sms

libgsmd_sms is about all related SMS functions. The API is as below:

  • List Messages: can list all SMS message by 'stat' value
extern int lgsm_sms_list(struct lgsm_handle *lh, enum gsmd_msg_sms_type stat);
  • Read Message: It can read one SMS message by 'index' value
extern int lgsm_sms_read(struct lgsm_handle *lh, int index);
  • Delete Message: can delete one SMS message by 'index' and 'del_flag' values
extern int lgsm_sms_delete(struct lgsm_handle *lh, const struct lgsm_sms_delete *sms_del);
  • Send Message: can send one SMS message
extern int lgsm_sms_send (struct lgsm_handle *lh, const struct lgsm_sms *sms);
  • Write Message to Memory: can write one SMS message to preferred memory
extern int lgsm_sms_write (struct lgsm_handle *lh, const struct lgsm_sms_write *sms_write);
  • Retrieve SMS storage Information: retrieve all SMS storage information
extern int lgsm_sms_get_storage (struct lgsm_handle *lh);
  • Set preferred SMS storage: can set SMS preferred storage
extern int lgsm_sms_set_storage (struct lgsm_handle *lh, enum ts0705_mem_type mem1, enum ts0705_mem_type mem2, enum ts0705_mem_type mem3);
  • Retrieve current default service center address
extern int lgsm_sms_get_smsc(struct lgsm_handle *lh);
  • Set new default service center address
extern int lgsm_sms_set_smsc(struct lgsm_handle *lh, const char *number);
  • Packing of 7-bit characters
extern int packing_7bit_character(const char *src, struct lgsm_sms *dest);

libgsmd-tool

Please reference to here

Debug Log

To-do

Personal tools

Overview

What is gsmd

Gsmd is a daemon that handles the communication between applications and GSM modem. Applications control gsmd through libgsmd. libgsmd communicates with gsmd through unix socket, and modem goes through Uart. The diagram is as following.

http://lh6.google.com/ticktock35/RwDCAWdUPEI/AAAAAAAAAD4/wBrRLv-1oyE/s400/gsmd_overview.jpg

Gsmd

GSMD is a event driven daemon. Each event shall has a response. Every event will pass through the gsmd_select_main() in which finding and executing their correspond call back functions.

The last part of gsmd main function enters a infinite loop, trying to call gsmd_select_main.

while(1) {
         int ret = gsmd_select_main();
         ...
 }

gsmd_select_main()

gsmd_select_main this is core of the call back function scheme. All devices, gsmd monitors and linked in a list, are described as a struct gsmd_fd, and gsmd_select_main will select them. Once an event comes out from one of the devices, gsmd_select_main will try to call it's call back function that devices registered.

int gsmd_select_main()
{
       struct gsmd_fd *ufd, *ufd2;
       fd_set readset, writeset, exceptset;
       int i;

       FD_ZERO(&readset);
       FD_ZERO(&writeset);
       FD_ZERO(&exceptset);

       /* prepare read and write fdsets */
       llist_for_each_entry(ufd, &gsmd_fds, list) {
               if (ufd->when & GSMD_FD_READ)
                       FD_SET(ufd->fd, &readset);

               if (ufd->when & GSMD_FD_WRITE)
                       FD_SET(ufd->fd, &writeset);

               if (ufd->when & GSMD_FD_EXCEPT)
                       FD_SET(ufd->fd, &exceptset);
       }

       i = select(maxfd+1, &readset, &writeset, &exceptset, NULL);
       if (i > 0) {
               /* call registered callback functions */
               llist_for_each_entry_safe(ufd, ufd2, &gsmd_fds, list) {
                       int flags = 0;

                       if (FD_ISSET(ufd->fd, &readset))
                               flags |= GSMD_FD_READ;

                       if (FD_ISSET(ufd->fd, &writeset))
                               flags |= GSMD_FD_WRITE;
 
                       if (FD_ISSET(ufd->fd, &exceptset))
                               flags |= GSMD_FD_EXCEPT;

                       if (flags)
                               ufd->cb(ufd->fd, flags, ufd->data);
               }
       }
       return i;
}


gsmd_fd

struct gsmd_fd {
    struct llist_head list;
    int fd;                         /* file descriptor */
    unsigned int when;
    int (*cb)(int fd, unsigned int what, void *data);
    void *data;                     /* void * to pass to callback */
};

When there are anything change in fd, the gsmd_select_main will detect them and try to call it's call back function cb.

That means if you redirect the cb to another implementation, the gsmd will behave very differently.

gsmd_atcmd

struct gsmd_atcmd {
       struct llist_head list;
       void *ctx;
       int (*cb)(struct gsmd_atcmd *cmd, void *ctx, char *resp);
       char *resp;
       int32_t ret;
       u_int32_t buflen;
       u_int16_t id;
       u_int8_t flags;
       char *cur;
       char buf[];
};

call back functions

Gsmd opens at least one devices. One is uart to modem and others are the Unix socket, communicating with libgsmd.

atcmd_select_cb is the default call back function that dealing the uart to the modem. It will handle sending AT command to modem or receive whatever return from modem and send them into parser.

The default parser call back function of uart (to modem) is ml_parse, in which dealing with reading the response of modem dispatch the correct call back function to handle the response.

atcmd_select_cb

atcmd_fill
atcmd_submit

ml_parse

ml_parse is the parser call back function that handles:

  • Initial GSM Modem
  • handle correspond AT command call back
  • handle notification call back
initial GSM Modem

When the modem firmware is ready to initial, it will send AT-Command Interpreter ready to gsmd. If ml_parse get this string, gsmd will try to initialize the modem.

       if (strlen(buf) == 0 ||
           !strcmp(buf, "AT-Command Interpreter ready")) {
               g->interpreter_ready = 1;
               gsmd_initsettings(g);
               gmsd_alive_start(g);
               return 0;
       }

What modem write to gsmd will put in "buf". And if the contents of the "buf" is "AT-Command Interpreter ready" the automatic gsmd initialize will start.

gsmd_alive_start is a scheme that gsmd detect if the modem is still alive or not. It will send an "AT" to modem periodically, and check the modem's response.

handle correspond AT command call back
handle notification call back

libgsmd

libgsmd is a library with C language API for application programs. Programs using this library can use the phone, e.g. make phone calls, receive incoming calls, register to the network, etc.

libgsmd_sms

libgsmd_sms is about all related SMS functions. The API is as below:

  • List Messages: can list all SMS message by 'stat' value
extern int lgsm_sms_list(struct lgsm_handle *lh, enum gsmd_msg_sms_type stat);
  • Read Message: It can read one SMS message by 'index' value
extern int lgsm_sms_read(struct lgsm_handle *lh, int index);
  • Delete Message: can delete one SMS message by 'index' and 'del_flag' values
extern int lgsm_sms_delete(struct lgsm_handle *lh, const struct lgsm_sms_delete *sms_del);
  • Send Message: can send one SMS message
extern int lgsm_sms_send (struct lgsm_handle *lh, const struct lgsm_sms *sms);
  • Write Message to Memory: can write one SMS message to preferred memory
extern int lgsm_sms_write (struct lgsm_handle *lh, const struct lgsm_sms_write *sms_write);
  • Retrieve SMS storage Information: retrieve all SMS storage information
extern int lgsm_sms_get_storage (struct lgsm_handle *lh);
  • Set preferred SMS storage: can set SMS preferred storage
extern int lgsm_sms_set_storage (struct lgsm_handle *lh, enum ts0705_mem_type mem1, enum ts0705_mem_type mem2, enum ts0705_mem_type mem3);
  • Retrieve current default service center address
extern int lgsm_sms_get_smsc(struct lgsm_handle *lh);
  • Set new default service center address
extern int lgsm_sms_set_smsc(struct lgsm_handle *lh, const char *number);
  • Packing of 7-bit characters
extern int packing_7bit_character(const char *src, struct lgsm_sms *dest);

libgsmd-tool

Please reference to here

Debug Log

To-do