---

modem.c

/*! \brief modem.c
     This file contains all functionn associated with the modem's manipulation.
 */

#include <string.h>
#include "modem.h"

#ifndef USE_PLUGINS
    #include "hitachi.h"
#endif

/*! \brief Debug mode. */

static int DEBUG = 0;

/*! \brief Pointer to the log file used by this module.
 */

static char    *log_file = NULL;

/*! \brief Fake logging service (used if logging is not activated).
    \author Denis BEURIVE
 */

static int my_fake_syslog (const char *file, const char * fmt,...) { return 0; }

/*! \brief Pointer to the log routine used by this module.
    \remark By default, the module uses a fake syslog routine that does nothing.
            You must call the function init_modem_syslog() to assign a new syslog routine.
 */

static int     (*my_syslog) (const char *file, const char * fmt,...) = my_fake_syslog;

/*! \author Denis BEURIVE
    \brief Initialize the syslog service.
    \param syslog Pointer to a function used to log messages. The function signature must be :<P>
           int syslog (const char *file, const char * fmt,...)<P>
           Upon successful completion, the function returns the value 0.<P>
           To desactivate logging, just set this pointer to NULL.<P>
           If NULL, logging service is not activated (no matter the value of 'log').
    \param log Pointer to the log file.
           If NULL, logging service is not activated (no matter the value of 'syslog').
    \param debug Integer that set the debug level (0: no debug).
 */

void init_modem_syslog (int (*syslog)(const char *file, const char * fmt,...),
                        char *log,
                        int debug)
{
  if ((syslog != NULL) && (log != NULL))
  {
     my_syslog = syslog;
     log_file  = log;
     DEBUG     = debug;
  }
  else { my_syslog = my_fake_syslog; }

  return;
}

/*! \author Denis BEURIVE
    \brief Find the manufacturor of a modem (looking at the DHCP packet).
    \param packet Pointer to a 'dhcp_packet' data structure that represents the incoming packet.
           associated with the interace.
    \return The function returns an integer value that represents the modem's manufacturor.
            The list of possible values is defined in the file 'modem.h'.
    \remark The returned value MODEM_UNKNOWN means that the modem is not in the list of 
            selected modems. This is not an error. 
 */

int get_modem_manufacturor (struct dhcp_packet *packet)
{
  char    *haddr;

  /* ------------------------------------------------------------------ */
  /* Lookup MAC address                                                 */
  /* ------------------------------------------------------------------ */

  haddr = packets_get_chaddr_no_separator(packet);

  #ifdef USE_PLUGINS

       return (modem_conf_get_id(haddr));

  #else

       if (strncmp(haddr, HITACHI_MARK1, strlen(HITACHI_MARK1)) == 0) { return MODEM_HITACHI; }
       if (strncmp(haddr, HITACHI_MARK2, strlen(HITACHI_MARK2)) == 0) { return MODEM_HITACHI; }
       if (strncmp(haddr, SAGEM_MARK1,   strlen(SAGEM_MARK1))   == 0) { return MODEM_SAGEM;   }
       if (strncmp(haddr, SAGEM_MARK2,   strlen(SAGEM_MARK2))   == 0) { return MODEM_SAGEM;   }
       return MODEM_UNKNOWN;

  #endif
}

/*! \author Denis BEURIVE
    \brief Calculate the modem's network MAC address from the modem mother board MAC address.
    \param packet Pointer to a 'dhcp_packet' data structure that represents the incoming packet.
    \param manufacturor Integer value that represents the modem's manufacturor (as returnrd by the
                        function get_modem_manufacturor()).
    \return The function returns a pointer to a statically allocated string of characters that represents
            the mac address in hexadecimal notation (without ':').
 */

char *calculate_modem_mac_address (struct dhcp_packet *packet, int manufacturor)
{
  char *real_haddr;
  static char   haddr_hexa[DHCP_P_STR_HADDR_SIZE_EXACT];

  #ifndef USE_PLUGINS
  #else
      char *new_haddr;
      char* (*calculate_mac_address)(char*);
  #endif

  real_haddr = packets_get_chaddr_no_separator(packet);
  memset ((void*)haddr_hexa, 0, DHCP_P_STR_HADDR_SIZE_EXACT);
  strncpy (haddr_hexa, real_haddr, DHCP_P_STR_HADDR_SIZE_EXACT-1);

  #ifndef USE_PLUGINS
    
      /* -------------------------------------------------------------- */
      /* HITACHI - substract 4 from the MAC address                     */
      /*                                                                */
      /* NOTE: sizeof(BigNumDigit)=4 bytes !!!                          */
      /* -------------------------------------------------------------- */
        
      if (manufacturor == MODEM_HITACHI)
      {
        calculate_mac (haddr_hexa);
    
        if (DEBUG > 1)
        {
          my_syslog (log_file, "[DEBUG] [%s:%d] calculate_modem_mac_address: HITACHI MAC address [%s] => [%s]",
                     __FILE__, __LINE__, real_haddr, haddr_hexa); 
        }
    
        return haddr_hexa;
      }
    
      /* -------------------------------------------------------------- */
      /* Other modem => return the MAC address "as is"                  */
      /* -------------------------------------------------------------- */
    
      if (DEBUG > 1)
      {
        my_syslog (log_file, "[DEBUG] [%s:%d] calculate_modem_mac_address: UNKNOWN MAC address [%s] => [%s]",
                              __FILE__, __LINE__, real_haddr, haddr_hexa);
      }
    
      return haddr_hexa;

  #else

      calculate_mac_address = (char*(*)(char*))modem_conf_get_function(manufacturor);
      new_haddr = (*calculate_mac_address)(haddr_hexa);

      if (DEBUG > 1)
      {
        my_syslog (log_file, "[DEBUG] [%s:%d] calculate_modem_mac_address: MAC [%s] => [%s]",
                   __FILE__, __LINE__, real_haddr, new_haddr); 
      }

      return new_haddr;

  #endif
}

/*! \brief Return a string that represents the modem's manufacturor.
    \author Denis BEURIVE
    \param id Integer that represents the manufacturor (see file 'modem.h' for the list of IDs).
    \return The function returns a pointer to a zero terminated string of characters that represents
            the modem's manufacturor.
 */

char *id_manufacturor_to_string (int id)
{
  #ifndef USE_PLUGINS

      static char m_hitachi[] = "HITACHI";
      static char m_sagem[]   = "SAGEM";
      static char m_unknown[] = "UNKNOWN";
    
      switch (id)
      {
        case MODEM_HITACHI: return m_hitachi;
        case MODEM_SAGEM:   return m_sagem; 
        default: return m_unknown;
      }
    
      return m_unknown;

  #else

      return modem_conf_get_tag_name(id);

  #endif
}

---