Import additional CMS headers and update docs

diff --git a/README b/README
index 7240339..50c40ca 100644 (file)
--- a/README
+++ b/README
@@ -13,6 +13,8 @@ I've copied the files from the Zyxel source-code distribution as the basis of th
 
  cp Zyxel/source/userspace/public/libs/cms_util/lzw*.c .
  cp Zyxel/source/userspace/public/include/cms_lzw.h .
 
  cp Zyxel/source/userspace/public/libs/cms_util/lzw*.c .
  cp Zyxel/source/userspace/public/include/cms_lzw.h .

+ cp userspace/public/include/linux/os_defs.h .
+ cp userspace/public/include/cms_version.h .

 
 With this tool it is possible to extract the payload from a firmware file. It is typically the second
 payload image in the file - the first being the CFE/Kernel/root file-system combination.
 
 With this tool it is possible to extract the payload from a firmware file. It is typically the second
 payload image in the file - the first being the CFE/Kernel/root file-system combination.

diff --git a/cms_params.h b/cms_params.h
new file mode 100644 (file)
index 0000000..482652c
--- /dev/null
+++ b/cms_params.h
@@ -0,0 +1,298 @@
+/***********************************************************************
+ *
+ *  Copyright (c) 2006-2007  Broadcom Corporation
+ *  All Rights Reserved
+ *
+ * <:label-BRCM:2011:DUAL/GPL:standard
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2, as published by
+ * the Free Software Foundation (the "GPL").
+ * 
+ * This program 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 General Public License for more details.
+ * 
+ * 
+ * A copy of the GPL is available at http://www.broadcom.com/licenses/GPLv2.php, or by
+ * writing to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ * 
+:>
+ *
+ ************************************************************************/
+
+#ifndef __CMS_PARAMS_H__
+#define __CMS_PARAMS_H__
+
+/*!\file cms_params.h
+ * \brief Header file containing customizable or board/hardware dependent
+ *        parameters for the the CPE Management System (CMS).  Note that
+ *        other customizable parameters are modified via make menuconfig.
+ */
+
+
+/** Config file version.
+ *
+ */
+#define CMS_CONFIG_FILE_VERSION "3.0"
+
+
+/** Number of spaces to indent each line in the config file.
+ *
+ */
+#define CMS_CONFIG_FILE_INDENT 2
+
+
+/** Address where the shared memory region is attached.
+ *
+ * Every process must attach to the shared memory at the same address
+ * because the data structures inside the shared memory region contain
+ * pointers to other areas in the shared memory.
+ */
+#define MDM_SHM_ATTACH_ADDR  0x58800000
+
+
+/** Base amount of shared memory to allocate.
+ *
+ */
+#define MDM_SHM_BASE_SIZE         (160 * 1024)
+
+
+/** Amount of shared memory to allocate if WLAN feature is enabled.
+ *
+ */
+#define MDM_SHM_WLAN_EXTRA        (128 * 1024)
+
+
+/** Amount of shared memory to allocate if VOIP feature is enabled.
+ *
+ */
+#define MDM_SHM_VOIP_EXTRA        (128 * 1024)
+
+
+/** Amount of shared memory to allocate if GPON feature is enabled.
+ *
+ */
+#define MDM_SHM_GPON_EXTRA        (128 * 1024)
+
+/** Amount of shared memory to allocate if extra large DSL data is enabled.
+ *
+ */
+#define MDM_SHM_DSL_BIG_DATA_EXTRA  (256 * 1024)
+
+/** The "key" to use when requesting a semaphore from the Linux OS.
+ *
+ * This is used to implement low level MDM transation locks.
+ * The only time this will need to be modified is when other code
+ * is using the same key.
+ */
+#define MDM_LOCK_SEMAPHORE_KEY 0x5ed7
+
+
+/** This is the Unix Domain Socket address for communications with smd used
+ *  by the messaging library.
+ *
+ * Note two different addresses are defined, one for modem and one for DESKTOP_LINUX testing.
+ *  It is highly unlikely that this needs to be changed.
+ */
+#ifdef DESKTOP_LINUX
+#define SMD_MESSAGE_ADDR  "/var/tmp/smd_messaging_server_addr"
+#else
+#define SMD_MESSAGE_ADDR  "/var/smd_messaging_server_addr"
+#endif
+
+
+/** This is the number of fully connected connections that can be queued
+ *  up at the SMD message server socket.
+ *
+ *  It is highly unlikely that this needs to be changed.
+ */
+#define SMD_MESSAGE_BACKLOG  3
+
+
+/** Special hack for the smd dynamic launch service, when it launches a server app, the
+ *  server app will find its server fd at this number.
+ *
+ * It is highly unlikely that this needs to be changed.
+ */
+#define CMS_DYNAMIC_LAUNCH_SERVER_FD  3
+
+
+
+/** This is the port ftpd listens on.
+ * 
+ * Note two different ports are defined, one for modem and one for DESKTOP_LINUX testing.
+ * It is highly unlikely that this needs to be changed.
+ */
+#ifdef DESKTOP_LINUX
+#define FTPD_PORT       44421
+#else
+#define FTPD_PORT       21
+#endif
+
+
+/** This is the port tftpd listens on.
+ * 
+ * Note two different ports are defined, one for modem and one for DESKTOP_LINUX testing.
+ * It is highly unlikely that this needs to be changed.
+ */
+#ifdef DESKTOP_LINUX
+#define TFTPD_PORT      44469
+#else
+#define TFTPD_PORT      69
+#endif
+
+
+/** This is the port sshd listens on.
+ * 
+ * Note two different ports are defined, one for modem and one for DESKTOP_LINUX testing.
+ * It is highly unlikely that this needs to be changed.
+ */
+#ifdef DESKTOP_LINUX
+#define SSHD_PORT       44422
+#else
+#define SSHD_PORT       22
+#endif
+
+
+/** The amount of idle time, in seconds, before sshd exits.
+ *
+ * Make this relatively long because the user might be configuring something,
+ * then gets confused and have to look up some manual.
+ * If 0, then no timeout.
+ */
+#define SSHD_EXIT_ON_IDLE_TIMEOUT  600
+
+
+/** This is the port telnetd listens on.
+ * 
+ * Note two different ports are defined, one for modem and one for DESKTOP_LINUX testing.
+ * It is highly unlikely that this needs to be changed.
+ */
+#ifdef DESKTOP_LINUX
+#define TELNETD_PORT    44423
+#else
+#define TELNETD_PORT    23
+#endif
+
+
+/** The amount of idle time, in seconds, before telnetd exits.
+ *
+ * Make this relatively long because the user might be configuring something,
+ * then gets confused and have to look up some manual.
+ * If 0, then no timeout.
+ */
+#define TELNETD_EXIT_ON_IDLE_TIMEOUT  600
+
+
+/** This is the port httpd listens on.
+ * 
+ * Note two different ports are defined, one for modem and one for DESKTOP_LINUX testing.
+ * It is highly unlikely that this needs to be changed.
+ */
+#ifdef DESKTOP_LINUX // __\14MTS__, Richard Huang
+#define HTTPD_PORT      44480
+#else
+#ifdef SUPPORT_HTTPD_SSL
+#define HTTPD_PORT_SSL      443
+#endif
+#define HTTPD_PORT      80
+#endif
+
+
+/** The amount of idle time, in seconds, before httpd exits.
+ *
+ * Make this relatively long because the user might be configuring something,
+ * then gets confused and have to look up some manual.
+ */
+#define HTTPD_EXIT_ON_IDLE_TIMEOUT  600
+
+
+/** The amount of idle time, in seconds, before consoled exits.
+ *
+ * Make this relatively long because the user might be configuring something,
+ * then gets confused and have to look up some manual.
+ * If 0, then no timeout.
+ */
+#define CONSOLED_EXIT_ON_IDLE_TIMEOUT  600
+
+
+/** This is the port snmpd listens on.
+ * 
+ * Note two different ports are defined, one for modem and one for DESKTOP_LINUX testing.
+ * It is highly unlikely that this needs to be changed.
+ */
+#ifdef DESKTOP_LINUX
+#define SNMPD_PORT      44161
+#else
+#define SNMPD_PORT      161
+#endif
+
+/** This is the port tr64c listens on.
+* LGD_TODO: Due to the time limit, it still have one DESKTOP_LINUX version TR64C, 
+* in the future will add it.
+*/
+#define TR64C_HTTP_CONN_PORT     49431
+
+
+/** This is the port tr69c listens on for connection requests from the ACS.
+ * 
+ */
+#define TR69C_CONN_REQ_PORT      30005
+
+
+/** This is the path part of the URL for tr69c connection requests from the ACS.
+ * 
+ */
+#ifdef BUILD_EIRCOM_CUSTOMIZATION
+#define TR69C_CONN_REQ_PATH      "/tr069"
+#else
+#define TR69C_CONN_REQ_PATH      "/"
+#endif
+
+/** The amount of idle time, in seconds, before tr69c exits.
+ *
+ * This value does not need to be very large because the ACS is usually running
+ * a script so it will do all the actions it needs back-to-back and then be
+ * completely done.  So if we see no more requests from the ACS for 30 seconds,
+ * that probably means the ACS is completely done.  However, if response time
+ * is very important, and you do not want the tr69c client to exit, then you
+ * can set this to a very large value (e.g. 2160356, which is one year).
+ */
+#define TR69C_EXIT_ON_IDLE_TIMEOUT       30 
+
+
+/** Maximum number of Layer 2 bridges supported.
+ * 
+ * If this value is changed, be sure to also modify the default value in
+ * the data model.
+ */
+#define MAX_LAYER2_BRIDGES                16
+
+
+/** Maximum depth of objects in the Data Model that we can support.
+ *  If the data model has a greater actual depth than what is defined here,
+ *  cmsMdm_init() will fail.
+ */
+#define MAX_MDM_INSTANCE_DEPTH    6
+
+
+/** Maximum length of a parameter name in the Data Model that we can support.
+ *  If the data model has a greater actual param name length than what is defined here,
+ *  cmsMdm_init() will fail.
+ */
+#define MAX_MDM_PARAM_NAME_LENGTH   55
+
+/** DNS Probing parameters for both dnsprobe and dproxy. They probe every
+ * 30 seconds. Timeout is 3 seconds and only retry 2 more times. */
+#if 1//__MSTC__,kenny, Reduce waiting time for switch DNS Server
+#define DNS_PROBE_INTERVAL 10
+#else
+#define DNS_PROBE_INTERVAL 30
+#endif
+#define DNS_PROBE_TIMEOUT 3 
+#define DNS_PROBE_MAX_TRY 3
+
+#endif  /* __CMS_PARAMS_H__ */

diff --git a/cms_version.h b/cms_version.h
new file mode 100644 (file)
index 0000000..04d021c
--- /dev/null
+++ b/cms_version.h
@@ -0,0 +1,6 @@
+/* this is an automatically generated file.  Do not modify. */
+/* modify version.make at the top. */
+#ifndef _CMS_VERSION_H_
+#define _CMS_VERSION_H_
+#define CMS_RELEASE_VERSION "4.12L.06B"
+#endif

diff --git a/os_defs.h b/os_defs.h
new file mode 100644 (file)
index 0000000..de68f7f
--- /dev/null
+++ b/os_defs.h
@@ -0,0 +1,156 @@
+/***********************************************************************
+ *
+ *  Copyright (c) 2006-2007  Broadcom Corporation
+ *  All Rights Reserved
+ *
+# 
+# 
+# This program is free software; you can redistribute it and/or modify 
+# it under the terms of the GNU General Public License, version 2, as published by  
+# the Free Software Foundation (the "GPL"). 
+# 
+#
+# 
+# This program 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 General Public License for more details. 
+#  
+# 
+#  
+#   
+# 
+# A copy of the GPL is available at http://www.broadcom.com/licenses/GPLv2.php, or by 
+# writing to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 
+# Boston, MA 02111-1307, USA. 
+#
+ *
+ ************************************************************************/
+
+#ifndef __OS_DEFS_H__
+#define __OS_DEFS_H__
+
+#include <unistd.h>  /* for getopt */
+#include <stdio.h>   /* for snprintf */
+#include <stdint.h>  /* for the various integer types */
+#include <stdlib.h>  /* for NULL */
+#include <string.h>  /* for strlen, strncpy */
+#include <ctype.h>   /* for isdigit */
+#include <syslog.h>  /* for syslog */
+#include <stdarg.h>  /* for va_list */
+#include "cms_params.h"
+
+/*!\file os_defs.h
+ * \brief Various commonly used, but OS dependent definitions are defined here.
+ *
+ *  This file is for Linux.
+ */
+
+#ifndef NUMBER_TYPES_ALREADY_DEFINED
+#define NUMBER_TYPES_ALREADY_DEFINED
+
+/** Unsigned 64 bit integer.
+ * This data type was introduced in TR-106 Issue 1, Admendment 2, Sept. 2008
+ */
+typedef uint64_t   UINT64;
+
+/** Signed 64 bit integer.
+ * This data type was introduced in TR-106 Issue 1, Admendment 2, Sept. 2008
+ */
+typedef int64_t    SINT64;
+
+/** Unsigned 32 bit integer. */
+typedef uint32_t   UINT32;
+
+/** Signed 32 bit integer. */
+typedef int32_t    SINT32;
+
+/** Unsigned 16 bit integer. */
+typedef uint16_t   UINT16;
+
+/** Signed 16 bit integer. */
+typedef int16_t    SINT16;
+
+/** Unsigned 8 bit integer. */
+typedef uint8_t    UINT8;
+
+/** Signed 8 bit integer. */
+typedef int8_t     SINT8;
+
+#endif /* NUMBER_TYPES_ALREADY_DEFINED */
+
+
+#ifndef BOOL_TYPE_ALREADY_DEFINED
+#define BOOL_TYPE_ALREADY_DEFINED
+
+/**Boolean type; use 1 byte only, possible values are TRUE(1) or FALSE(0) only.
+ *
+ * TRUE/FALSE defined in cms.h
+ */
+typedef uint8_t    UBOOL8;
+
+#endif /* BOOL_TYPE_ALREADY_DEFINED */
+
+
+/** Base64 encoded string representation of binary data.
+ *
+ * This is to support TR69 data types.
+ */
+typedef char *     BASE64;
+
+
+/** Hex encoded string representation of binary data.
+ * This data type was introduced in TR-106 Issue 1, Admendment 2, Sept. 2008
+ *
+ * This is to support TR69 data types.
+ */
+typedef char *     HEXBINARY;
+
+
+/** String representation of date and time.
+ *
+ * This is to support TR69 data types.
+ */
+typedef char *     DATETIME;
+
+
+/** Invalid file descriptor number */
+#define CMS_INVALID_FD  (-1)
+
+
+/** Invalid process id.
+ *
+ * Management entities should not need to use this constant.  It is used
+ * by OS dependent code in the OAL layer.  But I put this constant here
+ * to make it easier to find.
+ */
+#define CMS_INVALID_PID   0
+
+
+/** A number to identify a MdmObject (but not the specific instance of
+ *  the object).
+ *
+ * MdmObjectId's are defined in mdm_oid.h.
+ */
+typedef UINT16 MdmObjectId;
+
+
+/** A structure to keep track of instance information.
+ *
+ * External callers can treat this as an opaque handle.
+ * Note the instance array must be of type UINT32 because
+ * the instance id's are constantly increasing, so we
+ * cannot save space by defining instance to be
+ * an array of UINT8's.
+ */
+typedef struct
+{
+   UINT8 currentDepth;                     /**< next index in the instance array 
+                                            *   to fill.  0 means empty. */
+   UINT32 instance[MAX_MDM_INSTANCE_DEPTH];/**< Array of instance id's. */
+} InstanceIdStack;
+
+
+
+#endif /* __OS_DEFS_H__ */
+