gpsmgr.h

/*
GPS daemon manager API. The API is used by those applications that
wish to use services provided by gps daemon i.e., they wish to receive
GPS data from the daemon. See README file for more details.

Copyright (C) 2006 Nokia Corporation. All rights reserved.

Author: Jukka Rissanen <jukka.rissanen@nokia.com>

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

/* $Id:$ */

#include <stdlib.h>
#include <stdio.h>
#include <sys/types.h>
#include <signal.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef gpsmgr_included
#define gpsmgr_included


#define GPS_TMP_DIR  "/tmp/"
#define GPS_CTRL_TMP_DIR  "/var/run/gps/"
#define GPS_CTRL_DIR "/var/lib/gps/"
#define GPS_INTERNAL_DEVICE "/dev/pgps"

/* gpsd pid is stored to this file, also tells if the gpsd
 * is running or not (if not locked, then gpsd is not running)
 */
#define GPSMGR_GPSD_LOCK GPS_TMP_DIR ".gpsmgr_gpsd"

/* Lock file that manages reference count of the clients */
#define GPSMGR_LOCK      GPS_TMP_DIR ".gpsmgr_lock"

/* Lock file that controls access to GPSMGR_LOCK file */
#define GPSMGR_LOCK2     GPS_TMP_DIR ".gpsmgr_lock2"

/* Status file that prevents the usage of BT GPS devices */
#define GPS_NO_BT        GPS_CTRL_DIR ".gps_no_bt"

/* Status file that contains name(s) of BT GPS devices to be used */
#define GPS_BT_DEVICES GPS_CTRL_DIR "gps_BT_devices"

/* Status file that contains name(s) of serial ports of (non-BT) GPS devices */
#define GPS_SERIAL_PORTS GPS_CTRL_DIR "gps_serial_ports"

/* Status file that prevents the usage of serial port (non-BT) GPS devices */
#define GPS_NO_SERIAL_PORTS GPS_CTRL_DIR ".gps_no_serial_ports"

/* Status about connected devices */
#define GPS_CONNECTED_DEVICES GPS_CTRL_TMP_DIR "gps_connected_devices"

/* User selected device (written by location applet) */
#define GPS_USER_SELECTED GPS_CTRL_DIR "gps_user_selected"


#define GPSMGR_MAX_APPLICATIONS 16
#define GPSMGR_MAX_GPS_DEVICES  8

/* Internal context information */
typedef struct {
        pid_t pid;           /* gpsd process pid (if we started it) */
        pid_t mgr_pid;       /* manager pid */
        char *file;          /* name of the locking file */
        int lock_file_desc;  /* only one lock file / application */
        int locking_slot;    /* what is our position in locking file, this
                              * is used as a reference count so that we 
                              * know when there is no more clients needing
                              * gpsd service
                              */

        int already_locked_by_us;
                             /* we already have the lock but gpsd is not yet
                              * running (used together with
                              * gpsmgr_is_gpsd_running() to atomically start
                              * gpsd)
                              */
} gpsmgr_t;


/* Send dbus signal when gpsd is started and stopped
 */
#define GPSMGR_SERVICE          "com.nokia.gpsmgr"
#define GPSMGR_INTERFACE        GPSMGR_SERVICE
#define GPSMGR_PATH             "/com/nokia/gpsmgr"
#define GPSMGR_GPSD_STATUS_SIG  "gpsd_status"

/* Parameter values in status signal
 */
#define GPSMGR_GPSD_STATUS_STARTED "started"
#define GPSMGR_GPSD_STATUS_STOPPED "stopped"
#define GPSMGR_GPSD_STATUS_RESTART "restart"
#define GPSMGR_GPSD_STATUS_STARTED_NUM 1
#define GPSMGR_GPSD_STATUS_STOPPED_NUM 2
#define GPSMGR_GPSD_STATUS_RESTART_NUM 3

#define GPSMGR_MODE_JUST_CHECK 1
#define GPSMGR_MODE_LOCK_IF_POSSIBLE (!GPSMGR_MODE_JUST_CHECK)

extern int gpsmgr_start(char *path, char **gps_devices, char *ctrl_sock, 
                        int debug_level, short port, gpsmgr_t *ctx);


extern int gpsmgr_stop(gpsmgr_t *ctx);


extern int gpsmgr_is_gpsd_running(gpsmgr_t *ctx, int *num_of_clients, int mode);

/* Return value defines for gpsmgr_is_gpsd_running() function.
 */
#define GPSMGR_NOT_RUNNING  0
#define GPSMGR_RUNNING      1
#define GPSMGR_READY_TO_RUN 2

extern int gpsmgr_set_debug_mode(int mode);


extern int gpsmgr_request_restart(void);

#endif /* gpsmgr_included */

#ifdef __cplusplus
}
#endif

---