iphb_internal.h

/**
   @brief Internal iphb service definitions

   @file iphb_internal.h

   Internal iphb service definitions

   <p>
   Copyright (C) 2008-2011 Nokia. All rights reserved.

   @author Raimo Vuonnala <raimo.vuonnala@nokia.com>
   @author Semi Malinen <semi.malinen@nokia.com>

   This file is part of Dsme.

   Dsme is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License
   version 2.1 as published by the Free Software Foundation.

   Dsme 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with Dsme.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef IPHB_INTERNAL_H
#define IPHB_INTERNAL_H

#include <sys/types.h>
#include <stdint.h>

#define HB_SOCKET_PATH		"/dev/shm/iphb"	    /**@brief IPC path between client and iphbd */
#define HB_KERNEL_DEVICE        "/dev/iphb"	    /**@brief Device between kernel module and iphbd */
#define HB_KERNEL_DEVICE_TEST   "/tmp/iphb"	    /**@brief Test device between kernel module and iphbd */

#if 0
#define HB_MINTIME(__interval) (__interval - __interval/3)	/* Default minimum heartbeat wait time	*/
#define HB_MAXTIME(__interval) (__interval + __interval/3)	/* Default maximum heartbeat wait time  */
#endif
#define HB_LKM_KICK_ME_PERIOD    	"30"				/**@brief Period (seconds) the kernel sends messages to iphbd when IP traffic is seen */

#include <dsme/messages.h>

/**@brief Message from client to iphbd ("wake me up") */
struct _iphb_wait_req_t {
  uint16_t mintime;     /*!< minimum wait time in seconds, zero means use default */
  uint16_t maxtime;     /*!< maximum wait time in seconds, zero means use default */
  pid_t    pid;         /*!< client process ID (PID) */
  // sizeof = 8

  /* Since 1.1.0 */
  uint8_t wakeup;       /*!< Flag for use with dsme internal waits.
                         *   If set to non-zero value, device will
                         *   wakeup to handle the internal wakeup
                         *   instead of handling it while woken up
                         *   due to external activity. */
  // sizeof = 9


  /* Since 1.2.0 */
  uint8_t version;	/*!< Request structure version:
			 *   0 <  1.2.0
			 *   1 >= 1.2.0
			 */
  uint16_t mintime_hi;  /*!< Extend minimum wait time to 32bit range */
  uint16_t maxtime_hi;  /*!< Extend maximum wait time to 32bit range */
  // sizeof = 14

  /* Note: The size of this structure can grow up to 64 bytes without causing
   *       binary compatibility breaks, see struct _iphb_req_t below */
};

/**@brief Message from iphbd to client ("wake up!") */
struct _iphb_wait_resp_t {
  time_t waited;  /*!< time in secs client really waited */
};



/**@brief Command code */
enum _iphb_cmd_t {
  IPHB_WAIT = 0,  /*!< wait heartbeat */
  IPHB_STAT = 1,  /*!< get statistics */
};



/**@brief Request */
struct _iphb_req_t {
  enum _iphb_cmd_t cmd;		   /*!< command code */
  union {
    struct _iphb_wait_req_t wait;  /*!< wait request */
    char dummy[64];
  }
  u;
};


enum {
    /* NOTE: dsme message types are defined in:
     * - libdsme
     * - libiphb
     * - dsme
     *
     * When adding new message types
     * 1) uniqueness of the identifiers must be
     *    ensured accross all these source trees
     * 2) the dsmemsg_id_name() function in libdsme
     *    must be made aware of the new message type
     */

    DSME_MSG_ENUM(DSM_MSGTYPE_WAIT,   0x00000600),
    DSME_MSG_ENUM(DSM_MSGTYPE_WAKEUP, 0x00000601),
};

typedef struct {
    DSMEMSG_PRIVATE_FIELDS
    struct _iphb_wait_req_t req;
    void*                   data;
} DSM_MSGTYPE_WAIT;

typedef struct {
    DSMEMSG_PRIVATE_FIELDS
    struct _iphb_wait_resp_t resp;
    void*                    data;
} DSM_MSGTYPE_WAKEUP;





#endif  /* IPHB_INTERNAL_H */