home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / SYSLVL.ZIP / syslevel.txt < prev   
Text File  |  1993-03-26  |  8KB  |  244 lines
  1.  
  2. =========================
  3. OS/2 Syslevel File Format
  4. =========================
  5.  
  6. 03-18-92
  7.  
  8. Duane S. Wood
  9. OS/2 Development
  10. Boca Raton, Florida
  11.  
  12. Syslevel Files
  13. --------------
  14.  
  15.   The new CSF uses the same syslevel file format from previous
  16. releases.  After successfully servicing a product, the syslevel
  17. file corresponding to that product is updated.  A list of the
  18. directories serviced for the product is also appended to the syslevel
  19. file after the SYSTABLE.
  20.  
  21.   Each Syslevel file is specific to one product.  This is consistent
  22. with the existing service design.
  23.  
  24. Syslevel File Format
  25. --------------------
  26.  
  27.   The following diagram shows the general format of a syslevel file.
  28.  
  29.      ╔═════════════════════════════╗
  30.      ║ header (SLFHEADER)          ║
  31.      ║       ...                   ║
  32. ┌────╫────── ulTableOffset         ║
  33. │    ║                             ║
  34. │    ╚═════════════════════════════╝
  35. │
  36. │
  37. └──>>╔═════════════════════════════╗
  38.      ║ SYSTABLE                    ║
  39.      ║       ...                   ║
  40.      ║       ...                   ║
  41.      ║       ...                   ║
  42.      ╚═════════════════════════════╝
  43.    **╔═════════════════════════════╗
  44.      ║ Updated directory list      ║
  45.      ║       ...                   ║
  46.      ║       ...                   ║
  47.      ║       ...                   ║
  48.      ╚═════════════════════════════╝
  49.  
  50.    ** Added after successful service
  51.  
  52.   The following are the 'C' definitions for the header (SLFHEADER) and
  53. the SYSTABLE structures:
  54.  
  55. /*--------------------------------------------------------------*\
  56.  * SLFHEADER - This structure contains the information in a     *
  57.  *         SYSLEVEL file header.  The first 2 fields are used   *
  58.  *         to verify that the file is actually a SYSLEVEL file. *
  59.  *         Also identified is the version, date, and offset to  *
  60.  *         the SYSTABLE information -- see SYSTABLE             *
  61. \*--------------------------------------------------------------*/
  62.  
  63. typedef struct _SLFHEADER {
  64.     USHORT    usSignature;              /* special # for id of syslevel file */
  65.     CHAR      achSignature[8];                     /* id, must be 'SYSLEVEL' */
  66.     CHAR      achJulian[5];                               /* date of version */
  67.     USHORT    usSlfVersion;           /* version of syslevel file, must be 1 */
  68.     USHORT    ausReserved[8];                                    /* reserved */
  69.     ULONG     ulTableOffset;                           /* offset of SYSTABLE */
  70. } SLFHEADER;
  71.  
  72.  
  73. /*--------------------------------------------------------------*\
  74.  * SYSTABLE - This structure contains the information about     *
  75.  *         a specific component of a particular system. This    *
  76.  *         info includes date and level information about the   *
  77.  *         system /subsystem and the particular component.      *
  78. \*--------------------------------------------------------------*/
  79.  
  80.                                             /* defines for bSysEdition field */
  81. #define SYSED_SE         0x00                       /* os/2 standard edition */
  82. #define SYSED_EE         0x01                       /* os/2 extended edition */
  83. #define SYSED_ES         0x02                      /* os/2 extended services */
  84. #define SYSED_GENERAL    0x0F                                  /* all others */
  85.  
  86. typedef struct _SYSTABLE {
  87.     USHORT    usSysId;                         /* identifies system/subsytem */
  88.     BYTE      bSysEdition;             /* edition of system, eg SE=00, EE=01 */
  89.     BYTE      bSysVersion;                   /* version, eg 1.00=10, 1.10=11 */
  90.     BYTE      bSysModify;                     /* modify, eg 1.00=00, 1.01=01 */
  91.     USHORT    usSysDate;                                   /* date of system */
  92.     CHAR      achCsdLevel[8];            /* subsytem CSD level, eg, XR?0000_ */
  93.     CHAR      achCsdPrev[8];             /* as above, except for prev system */
  94.     CHAR      achSysName[80];         /* Title of system / subsytem (ASCIIZ) */
  95.     CHAR      achCompId[9];                      /* component ID of subsytem */
  96.     BYTE      bRefreshLevel;                /* eg, for version 1.30.1, use 1 */
  97.     BYTE      bReserved;                              /* reserved, must be 0 */
  98.     CHAR      achType[9];            /* Null terminated type (8 chars +'\0') */
  99.     BYTE      usReserved[6];                          /* reserved, must be 0 */
  100. } SYSTABLE;
  101.  
  102. Detailed SYSTABLE Field Descriptions
  103. ------------------------------------
  104.  
  105.   This is a number that is assigned to each product that is supported for
  106. service.
  107.  
  108.   Currently assigned SYSIDs:
  109.  
  110.      SYSID   EXTENSION    (partial list)
  111.      -----   ---------
  112.  
  113.   [note:  other SYSIDs in the range A0x0 - F0x0 are used by IBM]
  114.  
  115.      C010  -    LMU   LAN Manager Utilities/2
  116.      C020  -    X25   IBM X25 Net Manager
  117.      C040  -    OSI   Communications Subsystem For OS/2 EE
  118.      C060  -    SNP   IBM Snap Dump
  119.      C070  -    ISB   ISDN Coprocessor Support Program Version 1.2
  120.      C080  -    CS2   C SET/2
  121.      C081  -    WF2   Work Frame/2
  122.      1000  -          OS/2 SE
  123.      1010  -          OS/2 Toolkit
  124.      2000  -          OS/2 Comm Mgr
  125.      2010  -          OS/2 Feature group 1  (3270 emulator)
  126.      2020  -          OS/2 Feature group 2  (Async)
  127.      4000  -          OS/2 Database Mgr
  128.      4010  -          OS/2 Query Mgr
  129.      5000  -          OS/2 LAN Requester
  130.      5010  -          OS/2 LAN Server
  131.  
  132.  
  133. bSysEdition
  134. -----------
  135.  
  136.   A number between 0 and 255 (x0-xFF) that represents the type 
  137. of product being serviced.
  138.  
  139.   OS/2 Standard Edition is 0
  140.   OS/2 Extended Edition is 1
  141.   OS/2 Extended Services is 2
  142.   All other products are classified with a general sysedition of 15 (x0F)
  143.  
  144. bSysVersion
  145. -----------
  146.  
  147.   A number between 1 and 255 (x1-xFF) that represents the
  148. major and minor version of the product being serviced.
  149.   The hi-order byte is the major version.  The lo-order byte is the
  150. minor version.  For example:
  151.  
  152.   version 1.0, use x10
  153.   version 1.1, use x11
  154.   version 2.0, use x20
  155.  
  156. bSysModify
  157. ----------
  158.  
  159.   This is a number between 0 and 255 (x0-xFF) that represents a
  160. modification version (eg, 2.01 is major version 2, minor version 0,
  161. and modify version 1)
  162.  
  163. usSysDate   
  164. ---------
  165.  
  166.   This date is the date of the product.
  167. This is represented by a 16-bit bitfield as follows (FDATE):
  168.  
  169.   unsigned day     : 5;
  170.   unsigned month   : 4;
  171.   unsigned year    : 7;
  172.  
  173. achCsdLevel
  174. -----------
  175.  
  176.   This field is very important.  It specifies the level of the product.
  177. It must be exactly 8 characters with underscore ('_') as its last
  178. character.
  179.   The first two characters are specific to the product:
  180.  
  181.   OS/2 Standard Edition - XR
  182.   OS/2 Extended Edition - WR
  183.  
  184.   The third character represents the country:
  185.  
  186. 0 - United States (Note: This is the digit zero, not letter O)
  187. C - Canada (French speaking)
  188. D - Denmark
  189. F - France
  190. G - German
  191. H - Netherlands
  192. I - Italy
  193. J - Japan
  194. L - Finland
  195. N - Norway
  196. P - Portugal
  197. S - Spain
  198. U - United Kingdom
  199. W - Sweden
  200.  
  201. achCsdPrev
  202. ----------
  203.  
  204.   This represents the previous level of the system and has the same
  205. form as achCsdLevel.  For an initial release, this should be the same
  206. as achCsdLevel.
  207.  
  208. achSysName
  209. ----------
  210.  
  211.   This is the translated name of the system.  This must be null-
  212. terminated and has a maximum length of 80 characters.
  213.  
  214. achCompId
  215. ---------
  216.  
  217.   This is a 9-digit ascii number that represents sub-products.
  218.   For IBM OS/2 Base Operating System, this is 560109001.
  219.  
  220. bRefreshLevel
  221. -------------
  222.  
  223.   This represents the refresh level.  This field is not matched
  224. by the service tool, but is displayed from syslevel.exe.
  225.   For version 1.30.1, use 1 for bRefreshLevel.
  226.  
  227. achType
  228. -------
  229.  
  230.   This field contains an optional, NULL terminated alphanumeric type that is
  231. defined by the application.  This field is only used by the OS/2 2.0 version
  232. of SYSLEVEL.EXE.  The OS/2 1.3 SYSLEVEL.EXE will ignore this field.  If
  233. no type is desired, this field must be all zero's (0).  Because the field is
  234. NULL terminated, it has a maximum length of 8 characters (+ NULL = 9).
  235.  
  236. usReserved
  237. ----------
  238.  
  239. All reserved fields must be zero (0).
  240.  
  241.  
  242. [end of file]
  243.  
  244.