home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / syslevel.zip / SYSLEVEL.SCR < prev   
Text File  |  1992-03-18  |  10KB  |  297 lines
  1. .pm 5;.ll 70
  2. .DH 4 us tc
  3. :frontm.
  4. :titlep.
  5. :title.OS/2 Syslevel File Format
  6. :date.
  7. :author.Duane S. Wood
  8. :address.
  9. :aline.OS/2 Development
  10. :aline.Boca Raton, Florida
  11. :aline.DWOOD at BCRVMPC1
  12. :eaddress.
  13. :etitlep.
  14. .*
  15. :toc.
  16. :body.
  17. :h3.Syslevel Files
  18. :p.The new CSF uses the same syslevel file format from previous
  19. releases.  After successfully servicing a product, the syslevel
  20. file corresponding to that product is updated.  A list of the
  21. directories serviced for the product is also appended to the syslevel
  22. file after the SYSTABLE.
  23. :p.Each Syslevel file is specific to one product.  This is consistent
  24. with the existing service design.
  25. :h4.Syslevel File Format
  26. :p.The following diagram shows the general format of a syslevel file.
  27. :fig place=inline frame=none
  28.      ╔═════════════════════════════╗
  29.      ║ header (SLFHEADER)          ║
  30.      ║       ...                   ║
  31. ┌────╫────── ulTableOffset         ║
  32. │    ║                             ║
  33. │    ╚═════════════════════════════╝
  34. │
  35. │
  36. │
  37. │
  38. └──>>╔═════════════════════════════╗
  39.      ║ SYSTABLE                    ║
  40.      ║       ...                   ║
  41.      ║       ...                   ║
  42.      ║       ...                   ║
  43.      ╚═════════════════════════════╝
  44.    **╔═════════════════════════════╗
  45.      ║ Updated directory list      ║
  46.      ║       ...                   ║
  47.      ║       ...                   ║
  48.      ║       ...                   ║
  49.      ╚═════════════════════════════╝
  50.  
  51.    ** Added after successful service
  52. :figcap.Syslevel File General Format
  53. :efig
  54. .pa
  55. :p.The following are the 'C' definitions for the header (SLFHEADER) and
  56. the SYSTABLE structures:
  57. .pm 0;.ll 80
  58. .fo off
  59. /*--------------------------------------------------------------*\
  60.  * SLFHEADER - This structure contains the information in a     *
  61.  *         SYSLEVEL file header.  The first 2 fields are used   *
  62.  *         to verify that the file is actually a SYSLEVEL file. *
  63.  *         Also identified is the version, date, and offset to  *
  64.  *         the SYSTABLE information -- see SYSTABLE             *
  65. \*--------------------------------------------------------------*/
  66.  
  67. typedef struct _SLFHEADER {
  68.     USHORT    usSignature;              /* special # for id of syslevel file */
  69.     CHAR      achSignature[8];                     /* id, must be 'SYSLEVEL' */
  70.     CHAR      achJulian[5];                               /* date of version */
  71.     USHORT    usSlfVersion;           /* version of syslevel file, must be 1 */
  72.     USHORT    ausReserved[8];                                    /* reserved */
  73.     ULONG     ulTableOffset;                           /* offset of SYSTABLE */
  74. } SLFHEADER;
  75.  
  76.  
  77. /*--------------------------------------------------------------*\
  78.  * SYSTABLE - This structure contains the information about     *
  79.  *         a specific component of a particular system. This    *
  80.  *         info includes date and level information about the   *
  81.  *         system /subsystem and the particular component.      *
  82. \*--------------------------------------------------------------*/
  83.  
  84.                                             /* defines for bSysEdition field */
  85. #define SYSED_SE         0x00                       /* os/2 standard edition */
  86. #define SYSED_EE         0x01                       /* os/2 extended edition */
  87. #define SYSED_ES         0x02                      /* os/2 extended services */
  88. #define SYSED_GENERAL    0x0F                                  /* all others */
  89.  
  90. typedef struct _SYSTABLE {
  91.     USHORT    usSysId;                         /* identifies system/subsytem */
  92.     BYTE      bSysEdition;             /* edition of system, eg SE=00, EE=01 */
  93.     BYTE      bSysVersion;                   /* version, eg 1.00=10, 1.10=11 */
  94.     BYTE      bSysModify;                     /* modify, eg 1.00=00, 1.01=01 */
  95.     USHORT    usSysDate;                                   /* date of system */
  96.     CHAR      achCsdLevel[8];            /* subsytem CSD level, eg, XR?0000_ */
  97.     CHAR      achCsdPrev[8];             /* as above, except for prev system */
  98.     CHAR      achSysName[80];         /* Title of system / subsytem (ASCIIZ) */
  99.     CHAR      achCompId[9];                      /* component ID of subsytem */
  100.     BYTE      bRefreshLevel;                /* eg, for version 1.30.1, use 1 */
  101.     BYTE      bReserved;                              /* reserved, must be 0 */
  102.     CHAR      achType[9];            /* Null terminated type (8 chars +'\0') */
  103.     BYTE      usReserved[6];                          /* reserved, must be 0 */
  104. } SYSTABLE;
  105. .fo on
  106. .pm 5;.ll 70
  107. :h4.Detailed SYSTABLE Field Descriptions
  108. :dl tsize=15.
  109. :dt.usSysId
  110. :dd.This is a number that is assigned to each product that is supported for
  111. service.
  112. :p.Currently assigned SYSIDs:
  113. .pm 0;.ll 80
  114. .fo off
  115.      SYSID   EXTENSION
  116.      -----   ---------
  117.      F000  -    ???
  118.      F010  -    SD2
  119.      F020  -    TCP
  120.      F030  -    PNA
  121.      F040  -    TKT
  122.      F050  -    POS
  123.      F060  -    FXA
  124.      F070  -    CS2
  125.      F080  -    MLS
  126.      F090  -    HL2
  127.      F0A0  -    CPP
  128.      F0B0  -    CSE
  129.      F0C0  -    MOT
  130.      F0D0  -    FXM
  131.      F0E0  -    PCS
  132.      F0F0  -    POM
  133.      E000  -    PER
  134.      E010  -    TD2
  135.      E020  -    TR2
  136.      E030  -    NTC
  137.      E040  -    PW0
  138.      E050  -    PW1
  139.      E060  -    PW2
  140.      E070  -    PW3
  141.      E080  -    PW4
  142.      E090  -    ART   Artic OS/2 Support
  143.      E0A0  -    NDM
  144.      E0B0  -    OV2
  145.      E0C0  -    LDU
  146.      E0D0  -    NBT
  147.      E0E0  -    VCK
  148.      E0F0  -    VC2
  149.      D000  -    ES2
  150.      D010  -    EDS
  151.      D020  -    BS2
  152.      D030  -    BDM
  153.      D040  -    DS2
  154.      D050  -    IS2
  155.      D060  -    ED2
  156.      D070  -    DC2
  157.      D080  -    ELR
  158.      D090  -    ELB
  159.      D0A0  -    FS1
  160.      D0B0  -    FS2
  161.      D0C0  -    ENF
  162.      D0D0  -    TL2
  163.      D0E0  -    CWW   Common Workfolder Program Workplace/2
  164.      D0F0  -    CWS   Common Workfolder Program Server/2
  165.      C000  -    CWA   Common Workfolder Program API/2
  166.      C010  -    LMU   LAN Manager Utilities/2
  167.      C020  -    X25   IBM X25 Net Manager
  168.      C030  -    EQO   Floor Control/2
  169.      C040  -    OSI   Communications Subsystem For OS/2 EE
  170.      C050  -    EMQ   Starview PWS
  171.      C060  -    SNP   IBM Snap Dump
  172.      C070  -    ISB   ISDN Coprocessor Support Program Version 1.2
  173.      C080  -    CS2   C SET/2
  174.      C081  -    WF2   Work Frame/2
  175.      C090  -    XXX   Canada Trust customer apps (customer #519190633)
  176.      C0A0  -    PPV   Paperless Plan Viewer
  177.      C0B0  -    PPB   Paperless Plan Builder
  178.      C0C0  -    PPS   Paperless Plan Server
  179.      C0D0  -    PPP   Paperless Plan Packet
  180.      C0E0  -    EYN   Extended Operations Console Facility/2 (EOCF/2)
  181.      C0F0  -    XXX   Bank of Montreal Applications
  182.  
  183.      B000  -    XXX   ) Sears Applications
  184.      ...              )
  185.      B0F0             )
  186.  
  187.      A000  -    XXX   ) Cigna Written Applications
  188.      ...              )
  189.      A0F0             )
  190.  
  191.  
  192.      1000  -          OS/2 SE
  193.      1010  -          OS/2 Toolkit
  194.      2000  -          OS/2 Comm Mgr
  195.      2010  -          OS/2 Feature group 1  (3270 emulator)
  196.      2020  -          OS/2 Feature group 2  (Async)
  197.      4000  -          OS/2 Database Mgr
  198.      4010  -          OS/2 Query Mgr
  199.      5000  -          OS/2 LAN Requester
  200.      5010  -          OS/2 LAN Server
  201. .fo on
  202. .pm 5;.ll 70
  203. :dt.bSysEdition
  204. :dd.This is a number between 0 and 255 (x0-xFF) that represents the
  205. type of product being serviced.
  206. :sl.
  207. :li.OS/2 Standard Edition is 0
  208. :li.OS/2 Extended Edition is 1
  209. :li.OS/2 Extended Services is 2
  210. :li.All other products are classified with a general sysedition of 15 (x0F)
  211. :esl.
  212. :dt.bSysVersion
  213. :dd.This is a number between 1 and 255 (x1-xFF) that represents the
  214. major and minor version of the product being serviced.
  215. :p.The hi-order byte is the major version.  The lo-order byte is the
  216. minor version.  For example:
  217. :sl.
  218. :li.version 1.0, use x10
  219. :li.version 1.1, use x11
  220. :li.version 2.0, use x20
  221. :esl.
  222. :dt.bSysModify
  223. :dd.This is a number between 0 and 255 (x0-xFF) that represents a
  224. modification version (eg, 2.01 is major version 2, minor version 0,
  225. and modify version 1)
  226. :dt.usSysDate
  227. :dd.This date is the date of the product.
  228. :p.This is represented by a 16-bit bitfield as follows (FDATE):
  229. :sl compact.
  230. :li.unsigned day     &gml. 5;
  231. :li.unsigned month   &gml. 4;
  232. :li.unsigned year    &gml. 7;
  233. :esl.
  234. :dt.achCsdLevel
  235. :dd.This field is very important.  It specifies the level of the product.
  236. It must be exactly 8 characters with underscore ('_') as its last
  237. character.
  238. :p.The first two characters are specific to the product:
  239. :sl.
  240. :li.OS/2 Standard Edition - XR
  241. :li.OS/2 Extended Edition - WR
  242. :esl.
  243. :p.The third character represents the country:
  244. :dl compact tsize=5.
  245. :dt.0
  246. :dd.United States (Note: This is the digit zero, not letter O)
  247. :dt.C
  248. :dd.Canada (French speaking)
  249. :dt.D
  250. :dd.Denmark
  251. :dt.F
  252. :dd.France
  253. :dt.G
  254. :dd.German
  255. :dt.H
  256. :dd.Netherlands
  257. :dt.I
  258. :dd.Italy
  259. :dt.J
  260. :dd.Japan
  261. :dt.L
  262. :dd.Finland
  263. :dt.N
  264. :dd.Norway
  265. :dt.P
  266. :dd.Portugal
  267. :dt.S
  268. :dd.Spain
  269. :dt.U
  270. :dd.United Kingdom
  271. :dt.W
  272. :dd.Sweden
  273. :edl.
  274. :dt.achCsdPrev
  275. :dd.This represents the previous level of the system and has the same
  276. form as achCsdLevel.  For an initial release, this should be the same
  277. as achCsdLevel.
  278. :dt.achSysName
  279. :dd.This is the translated name of the system.  This must be null-
  280. terminated and has a maximum length of 80 characters.
  281. :dt.achCompId
  282. :dd.This is a 9-digit ascii number that represents sub-products.
  283. :p.For IBM OS/2 Base Operating System, this is 560109001.
  284. :dt.bRefreshLevel
  285. :dd.This represents the refresh level.  This field is not matched
  286. by the service tool, but is displayed from syslevel.exe.
  287. :p.For version 1.30.1, use 1 for bRefreshLevel.
  288. :dt.achType
  289. :dd.This field contains an optional, NULL terminated alphanumeric type that is
  290. defined by the application.  This field is only used by the OS/2 2.0 version
  291. of SYSLEVEL.EXE.  The OS/2 1.3 SYSLEVEL.EXE will ignore this field.  If
  292. no type is desired, this field must be all zero's (0).  Because the field is
  293. NULL terminated, it has a maximum length of 8 characters (+ NULL = 9).
  294. :dt.usReserved
  295. :dd.All reserved fields must be zero (0).
  296. :edl.
  297.