annotate docs/ccguide/crc.refentry @ 1417:b7b173926ea1

Changes and fixes by Robert Gault
author boisy
date Sun, 30 Nov 2003 22:25:56 +0000
parents c0da1728ed5b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
1 <refentry id="crc">
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
2 <refnamediv>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
3 <refname>Crc</refname>
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
4 <refpurpose>compute a cyclic redundancy count</refpurpose>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
5 </refnamediv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
6
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
7 <refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
8 <funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
9 <funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
10 <funcdef><function>crc</function></funcdef>
570
253b6096ee01 All function prototypes are added.
roug
parents: 540
diff changeset
11 <paramdef>char *<parameter>start</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 540
diff changeset
12 <paramdef>int <parameter>count</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 540
diff changeset
13 <paramdef>char <parameter>accum</parameter>[3]</paramdef>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
14 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
15 </funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
16
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
17 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
18
540
395a58bae72e All "See Also" implemented
roug
parents: 468
diff changeset
19 <refsect1><title>Assembler Equivalent</title>
395a58bae72e All "See Also" implemented
roug
parents: 468
diff changeset
20 <para>
395a58bae72e All "See Also" implemented
roug
parents: 468
diff changeset
21 os9 F$CRC
395a58bae72e All "See Also" implemented
roug
parents: 468
diff changeset
22 </para>
395a58bae72e All "See Also" implemented
roug
parents: 468
diff changeset
23 </refsect1>
395a58bae72e All "See Also" implemented
roug
parents: 468
diff changeset
24
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
25 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
26 <para>
594
c0da1728ed5b All refentries finished.
roug
parents: 570
diff changeset
27 This call accumulates a crc into a three byte array at "accum"
c0da1728ed5b All refentries finished.
roug
parents: 570
diff changeset
28 for "count" bytes starting at "start". All three bytes of
c0da1728ed5b All refentries finished.
roug
parents: 570
diff changeset
29 "accum" should be initialized to 0xff before the first call to
c0da1728ed5b All refentries finished.
roug
parents: 570
diff changeset
30 "crc()". However, repeated calls can be subsequently made to
c0da1728ed5b All refentries finished.
roug
parents: 570
diff changeset
31 cover an entire module. If the result is to be used as an OS-9
c0da1728ed5b All refentries finished.
roug
parents: 570
diff changeset
32 module crc, it should have its bytes complemented before
c0da1728ed5b All refentries finished.
roug
parents: 570
diff changeset
33 insertion at the end of the module.
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
34 </para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
35 </refsect1>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
36 </refentry>