VendorSoftwareFlowdat3
/
docsis


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
							<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <meta http-equiv="content-type"
 content="text/html; charset=ISO-8859-1">
  <title>index.html</title>
</head>
<body>
<big><big><span style="font-weight: bold;"></span></big></big><big><big><span
 style="font-weight: bold;"><a name="general"></a>General Information</span></big></big><br>
<br>
This software is copyright (c) 1999,2000,2001,2002 Cornel Ciocirlan and
copyright (c) 2002,2003 Evvolve Media SRL<br>
<br>
To contact the current maintainers and developers, send an E-mail to:
<a href="mailto:docsis@evvolve.com">docsis@evvolve.com</a>.<br>
To contact the original author, send an E-mail to:
ctrl@users.sourceforge.net.<br>
<br>
General questions about this software can be&nbsp; sent to
docsis-users@sourceforge.net.<br>
<br>
Visit <a href="http://docsis.sourceforge.net">http://docsis.sourceforge.net</a>
or&nbsp; <a href="http://sourceforge.net/projects/docsis">http://sourceforge.net/projects/docsis
</a>for the latest news on this program.<br>
<br>
<span style="font-weight: bold;">PLEASE READ THE FILE License.txt. You
cannot use this software unless you agree to the conditions of the GNU
General Public License, which are outlined in this file. </span><br>
<br style="font-weight: bold;">
<big style="font-weight: bold;"><big><a name="description"></a>Description</big></big><br>
<br>
This program encodes text configuration files which contain
Configuration File Settings into binary configuration files, as
specified by the DOCSIS RFI 1.1 <br>
Specification, Appendix C.<br>
<br>
It supports most DOCSIS 1.1 Configuration Settings. Not supported
(currently):<br>
<ul>
  <li>Telephony Settings</li>
  <li>Modem Capabilities</li>
  <li>TFTP server timestamp</li>
  <li>TFTP server provisioned modem address</li>
  <li>SNMPv3 settings (partial support provided)</li>
</ul>
See DOCSIS 2.0 Radio Frequency Interface Specification, Appendix C for
a description of these settings.<br>
<br>
<big><big><span style="font-weight: bold;"><a name="docsis10"></a>DOCSIS
1.0 considerations</span></big></big><br>
<br>
More than one (up to 16) ClassOfService statements can appear in the
configuration file. Only one BaselinePrivacy (BPI) statement can appear.<br>
The program does not check for the number of ClassOfService statements
that appear, you have to make sure not to include more than 16 or
unexpected results will occur&nbsp; (modems /CMTSes may reset).<br>
<br>
DOCSIS BPI Specification clearly states that the BPI settings MUST NOT
be present if Privacy is not enabled in [at least one of] the
ClassOfService<br>
parameters (for example if PrivacyEnable is 0 for all classes of
service, BPI statement should not appear).<br>
<br>
The program is not yet as "intelligent" as to detect these problems
automatically. <br>
<br>
<big style="font-weight: bold;"><big><a name="usage"></a>Usage</big></big><br>
<br>
There are three modes of operation:<br>
<br>
<ol>
  <li><span style="font-weight: bold;">Encoding CM configuration files</span><br>
    <br>
To
encode a CM configuration file, make sure
"docsis" is in your PATH and do:<br>
    <br>
&nbsp;<span style="font-family: monospace;">unix $ docsis
-e cm_config_file.cfg my_key_file cm_config_file.bin</span><br>
    <br>
The format of the text configuration file is
described <a href="config-format.html">here</a>. As sometimes
an example is more&nbsp; useful than a
truckload of documentation, we've included a few configuration files
(see examples/*.cfg).<br>
    <br>
In this mode of operation (triggered by the "-e"
switch), the program will need a keyfile; this is the so-called "shared
secret" or "authentication string". The program uses the string in the
keyfile to calculate the CMTS MIC. This string has to be configured on
the CMTS as well, otherwise the cable modem will not be able to
register. <br>
    <br>
An example key is provided in file testkey.key. The
key is only a string of characters. Any trailing newline (\n) or
carriage return (\r) characters are chopped to avoid confusion.<br>
    <br>
  </li>
  <li><span style="font-weight: bold;">Encoding PacketCable MTA
configuration files </span><br>
    <br>
MTA Configuration file support has been added in
version 0.8.1.<br>
    <br>
To encode a CM configuration file, make sure
"docsis" is in your PATH and do:<br>
    <br>
    <span style="font-family: monospace;">unix $ docsis -p
mta_config_file.cfg
mta_config_file.bin</span><br>
    <br>
PacketCable MTA config files MUST start with the
"MtaConfigDelimiter 1" configuration setting and MUST end with
"MtaConfigDelimiter 255". All<br>
other configuration settings must be either
SnmpMibObject or VendorSpecific. The program does not enforce this
policy so you must make&nbsp; sure you abide by it or the MTA will
reject the file.<br>
    <br>
  </li>
  <li> <span style="font-weight: bold;">Decoding CM or MTA binary
configuration files</span><br>
    <br>
To decode a binary file, do:<br>
    <br>
    <span style="font-family: monospace;">unix $ docsis -d
my_binary_file.bin</span><br>
    <br>
As of version 0.8, you can directly encode the
decoded output. E.g.<br>
    <br>
    <span style="font-family: monospace;">unix $ docsis -d cm_test.bin
&gt; cm_test.cfg</span><br style="font-family: monospace;">
    <span style="font-family: monospace;">unix $ docsis -e cm_test.cfg
testkey.key cm_test.bin</span><br style="font-family: monospace;">
    <span style="font-family: monospace;">unix $ docsis -d mta_test.bin
&gt; mta_test.cfg</span><br style="font-family: monospace;">
    <span style="font-family: monospace;">unix $ docsis -p mta_test.cfg
mta_test.bin</span><br>
    <br>
should work, save for still remaining bugs.<br>
    <br>
  </li>
</ol>
<big style="font-weight: bold;"><big><a name="add"></a>Adding new
configuration settings</big></big><br>
<br>
To add new configuration settings, in most cases the only thing you
need to do is add them to the docsis_symtable.h (make sure you select
the
correct<br>
type-functions for encoding and decoding).<br>
<br>
Because of the way the encoder works, the symbol_name must determine
all other values in the table with the exception of id and
parent.<br>
Thus if two symbols share the same name they must also share the same
docsis_code, type-functions, limits etc. Only the id and parent can be
different.<br>
</body>
</html>