├── .gitignore
├── src
    ├── CRC16USB.php
    ├── CRCInterface.php
    ├── CRC1.php
    ├── AbstractCRC.php
    ├── CRC16QT.php
    ├── CRC16XModem.php
    ├── CRC16ZModem.php
    ├── CRC16Modbus.php
    ├── CRC16CCITT.php
    ├── CRC16DNP.php
    └── CRC16.php
├── tests
    ├── bootstrap.php
    └── CRCSuiteTest.php
├── phpunit.xml.dist
├── composer.json
├── LICENSE
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | nbproject/
2 | vendor/
3 | composer.lock
4 | 


--------------------------------------------------------------------------------
/src/CRC16USB.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | class CRC16USB extends \mermshaus\CRC\CRC16
 6 | {
 7 |     protected $initChecksum = 0xffff;
 8 |     protected $xorMask = 0xffff;
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/CRCInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | interface CRCInterface
 6 | {
 7 |     public function reset();
 8 |     public function update($data);
 9 |     public function finish();
10 | }
11 | 


--------------------------------------------------------------------------------
/tests/bootstrap.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | if ( ! @include_once __DIR__ . '/../vendor/autoload.php') {
4 |     exit("You must set up the project dependencies, run the following commands:\n> wget http://getcomposer.org/composer.phar\n> php composer.phar install\n");
5 | }
6 | 


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <phpunit colors="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnError="false" stopOnFailure="false" stopOnIncomplete="false" stopOnSkipped="false" bootstrap="tests/bootstrap.php">
3 |     <testsuites>
4 |         <testsuite name="mermshaus/CRC">
5 |             <directory suffix="Test.php">tests/</directory>
6 |         </testsuite>
7 |     </testsuites>
8 | </phpunit>
9 | 


--------------------------------------------------------------------------------
/src/CRC1.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | class CRC1 extends AbstractCRC
 6 | {
 7 |     protected $lookup = array();
 8 | 
 9 |     public function update($data)
10 |     {
11 |         $len = strlen($data);
12 | 
13 |         for ($i = 0; $i < $len; $i++) {
14 |             $this->checksum = ($this->checksum + ord($data[$i])) % 256;
15 |         }
16 |     }
17 | 
18 |     public function pack($checksum)
19 |     {
20 |         return pack('C', $checksum);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "mermshaus/crc",
 3 |     "description": "Calculates CRC checksums for input data.",
 4 |     "keywords": [
 5 |         "crc"
 6 |     ],
 7 |     "license": "MIT",
 8 |     "authors": [
 9 |         {
10 |             "name": "Marc Ermshaus",
11 |             "email": "marc@ermshaus.org",
12 |             "homepage": "http://www.ermshaus.org/",
13 |             "role": "Developer"
14 |         }
15 |     ],
16 |     "autoload": {
17 |         "psr-4": {
18 |             "mermshaus\\CRC\\": "src",
19 |             "mermshaus\\CRC\\Tests\\": "tests"
20 |         }
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/src/AbstractCRC.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | abstract class AbstractCRC implements CRCInterface
 6 | {
 7 |     /**
 8 |      *
 9 |      * @var int
10 |      * @internal
11 |      */
12 |     protected $checksum;
13 | 
14 |     /**
15 |      *
16 |      * @var int
17 |      * @internal
18 |      */
19 |     protected $initChecksum = 0x0;
20 | 
21 |     /**
22 |      *
23 |      * @var int
24 |      * @internal
25 |      */
26 |     protected $xorMask = 0x0;
27 | 
28 |     public function __construct()
29 |     {
30 |         $this->reset();
31 |     }
32 | 
33 |     public function finish()
34 |     {
35 |         return $this->pack($this->getChecksum());
36 |     }
37 | 
38 |     public function reset()
39 |     {
40 |         $this->checksum = $this->initChecksum;
41 |     }
42 | 
43 |     /**
44 |      *
45 |      * @internal
46 |      */
47 |     protected function getChecksum()
48 |     {
49 |         return $this->checksum ^ $this->xorMask;
50 |     }
51 | 
52 |     /**
53 |      *
54 |      * @internal
55 |      */
56 |     abstract protected function pack($checksum);
57 | }
58 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2014 Marc Ermshaus <marc@ermshaus.org>
 2 | 
 3 |     Based on Digest CRC <https://github.com/postmodern/digest-crc>
 4 |     Copyright (c) 2010-2013 Hal Brodigan
 5 | 
 6 | Permission is hereby granted, free of charge, to any person obtaining a copy
 7 | of this software and associated documentation files (the "Software"), to deal
 8 | in the Software without restriction, including without limitation the rights
 9 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | copies of the Software, and to permit persons to whom the Software is
11 | furnished to do so, subject to the following conditions:
12 | 
13 | The above copyright notice and this permission notice shall be included in
14 | all copies or substantial portions of the Software.
15 | 
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | THE SOFTWARE.
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # mermshaus/CRC
 2 | 
 3 | This is work in progress. I am not an expert on the topic by any means. Therefore, I have trouble finding and verifying information about common CRC algorithms. I am especially looking for reliable test vectors.
 4 | 
 5 | ## Implemented algorithms
 6 | 
 7 | - CRC1
 8 | - CRC16, CRC16-CCITT, CRC16-DNP, CRC16-Modbus, CRC16-QT, CRC16-USB, CRC16-XModem, CRC16-ZModem
 9 | 
10 | ## Usage example
11 | 
12 | ```PHP
13 | <?php
14 | 
15 | // Autoloading via Composer
16 | require __DIR__ . '/vendor/autoload.php';
17 | 
18 | $crc16ccitt = new mermshaus\CRC\CRC16CCITT();
19 | 
20 | $crc16ccitt->update('Hello');
21 | $crc16ccitt->update(' World!');
22 | 
23 | $checksum = $crc16ccitt->finish();
24 | 
25 | var_dump(bin2hex($checksum)); // string(4) "882a"
26 | ```
27 | 
28 | ## Testing
29 | 
30 | ``` bash
31 | $ phpunit
32 | ```
33 | 
34 | ## Credits
35 | 
36 | - This library is mostly a port of [Digest CRC](https://github.com/postmodern/digest-crc) for Ruby by Hal Brodigan.
37 | 
38 | ## Links
39 | 
40 | - [Digest CRC](https://github.com/postmodern/digest-crc). The Ruby library on which this library is based.
41 | - [pycrc](https://github.com/tpircher/pycrc). A tool for generating C code and corresponding lookup tables for diverse CRC algorithms. Used by Digest CRC.
42 | - [CRC calculation](http://www.zorc.breitbandkatze.de/crc.html). An online calculator to generate checksums for arbitrary polynomials and input. Recommended by pycrc.
43 | - [On-line CRC calculation and free library](http://www.lammertbies.nl/comm/info/crc-calculation.html). Another online calculator for some CRC algorithms.
44 | - [Catalogue of parametrised CRC algorithms](http://reveng.sourceforge.net/crc-catalogue/). Information about many different CRC algorithms.
45 | 


--------------------------------------------------------------------------------
/src/CRC16QT.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | /**
 6 |  * Implements the CRC16_CCITT algorithm used in QT algorithms
 7 |  */
 8 | class CRC16QT extends CRC16CCITT
 9 | {
10 |     protected $xorMask = 0xffff;
11 | 
12 |     protected $reverseCRCResult = true;
13 | 
14 |     protected $reverseData = true;
15 | 
16 |     protected function reverseByte($byte)
17 |     {
18 |         $ob = 0;
19 |         $b = (1 << 7);
20 | 
21 |         for ($i = 0; $i <= 7; $i++) {
22 |             if (($byte & $b) !== 0) {
23 |                 $ob |= (1 << $i);
24 |             }
25 |             $b >>= 1;
26 |         }
27 | 
28 |         return $ob;
29 |     }
30 | 
31 |     protected function reverseBits($cc)
32 |     {
33 |         $ob = 0;
34 |         $b = (1 << 15);
35 | 
36 |         for ($i = 0; $i <= 15; $i++) {
37 |             if (($cc & $b) !== 0) {
38 |                 $ob |= (1 << $i);
39 |             }
40 |             $b >>= 1;
41 |         }
42 | 
43 |         return $ob;
44 |     }
45 | 
46 |     public function update($data)
47 |     {
48 |         $len = strlen($data);
49 | 
50 |         for ($i = 0; $i < $len; $i++) {
51 |             $byte = ($this->reverseData)
52 |                 ? $this->reverseByte(ord($data[$i]))
53 |                 : ord($data[$i]);
54 | 
55 |             $this->checksum = ($this->lookup[(($this->checksum >> 8) ^ $byte) & 0xff] ^ ($this->checksum << 8)) & 0xffff;
56 |         }
57 |     }
58 | 
59 |     protected function getChecksum()
60 |     {
61 |         $checksum = $this->checksum;
62 |         $checksum ^= $this->xorMask;
63 | 
64 |         if ($this->reverseCRCResult) {
65 |             $checksum = $this->reverseBits($checksum);
66 |         }
67 | 
68 |         return $checksum;
69 |     }
70 | }
71 | 


--------------------------------------------------------------------------------
/src/CRC16XModem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | class CRC16XModem extends CRC16
 6 | {
 7 |     protected $lookup = array(
 8 |         0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
 9 |         0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
10 |         0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
11 |         0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
12 |         0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
13 |         0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
14 |         0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
15 |         0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
16 |         0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
17 |         0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
18 |         0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12,
19 |         0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
20 |         0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41,
21 |         0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
22 |         0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
23 |         0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
24 |         0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
25 |         0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
26 |         0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
27 |         0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
28 |         0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
29 |         0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
30 |         0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
31 |         0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
32 |         0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
33 |         0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3,
34 |         0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
35 |         0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
36 |         0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
37 |         0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
38 |         0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
39 |         0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
40 |     );
41 | 
42 |     public function update($data)
43 |     {
44 |         $len = strlen($data);
45 | 
46 |         for ($i = 0; $i < $len; $i++) {
47 |             $this->checksum = ($this->lookup[(($this->checksum >> 8) ^ ord($data[$i])) & 0xff] ^ ($this->checksum << 8)) & 0xffff;
48 |         }
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/CRC16ZModem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | class CRC16ZModem extends \mermshaus\CRC\CRC16
 6 | {
 7 |     protected $lookup = array(
 8 |         0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
 9 |         0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
10 |         0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
11 |         0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
12 |         0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
13 |         0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
14 |         0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
15 |         0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
16 |         0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
17 |         0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
18 |         0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12,
19 |         0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
20 |         0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41,
21 |         0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
22 |         0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
23 |         0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
24 |         0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
25 |         0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
26 |         0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
27 |         0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
28 |         0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
29 |         0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
30 |         0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
31 |         0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
32 |         0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
33 |         0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3,
34 |         0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
35 |         0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
36 |         0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
37 |         0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
38 |         0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
39 |         0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
40 |     );
41 | 
42 |     public function update($data)
43 |     {
44 |         $len = strlen($data);
45 | 
46 |         for ($i = 0; $i < $len; $i++) {
47 |             $this->checksum = ($this->lookup[(($this->checksum >> 8) ^ ord($data[$i])) & 0xff] ^ ($this->checksum << 8)) & 0xffff;
48 |         }
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/CRC16Modbus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | class CRC16Modbus extends CRC16
 6 | {
 7 |     protected $initChecksum = 0xffff;
 8 | 
 9 |     protected $lookup = array(
10 |         0x0000, 0xc0c1, 0xc181, 0x0140, 0xc301, 0x03c0, 0x0280, 0xc241,
11 |         0xc601, 0x06c0, 0x0780, 0xc741, 0x0500, 0xc5c1, 0xc481, 0x0440,
12 |         0xcc01, 0x0cc0, 0x0d80, 0xcd41, 0x0f00, 0xcfc1, 0xce81, 0x0e40,
13 |         0x0a00, 0xcac1, 0xcb81, 0x0b40, 0xc901, 0x09c0, 0x0880, 0xc841,
14 |         0xd801, 0x18c0, 0x1980, 0xd941, 0x1b00, 0xdbc1, 0xda81, 0x1a40,
15 |         0x1e00, 0xdec1, 0xdf81, 0x1f40, 0xdd01, 0x1dc0, 0x1c80, 0xdc41,
16 |         0x1400, 0xd4c1, 0xd581, 0x1540, 0xd701, 0x17c0, 0x1680, 0xd641,
17 |         0xd201, 0x12c0, 0x1380, 0xd341, 0x1100, 0xd1c1, 0xd081, 0x1040,
18 |         0xf001, 0x30c0, 0x3180, 0xf141, 0x3300, 0xf3c1, 0xf281, 0x3240,
19 |         0x3600, 0xf6c1, 0xf781, 0x3740, 0xf501, 0x35c0, 0x3480, 0xf441,
20 |         0x3c00, 0xfcc1, 0xfd81, 0x3d40, 0xff01, 0x3fc0, 0x3e80, 0xfe41,
21 |         0xfa01, 0x3ac0, 0x3b80, 0xfb41, 0x3900, 0xf9c1, 0xf881, 0x3840,
22 |         0x2800, 0xe8c1, 0xe981, 0x2940, 0xeb01, 0x2bc0, 0x2a80, 0xea41,
23 |         0xee01, 0x2ec0, 0x2f80, 0xef41, 0x2d00, 0xedc1, 0xec81, 0x2c40,
24 |         0xe401, 0x24c0, 0x2580, 0xe541, 0x2700, 0xe7c1, 0xe681, 0x2640,
25 |         0x2200, 0xe2c1, 0xe381, 0x2340, 0xe101, 0x21c0, 0x2080, 0xe041,
26 |         0xa001, 0x60c0, 0x6180, 0xa141, 0x6300, 0xa3c1, 0xa281, 0x6240,
27 |         0x6600, 0xa6c1, 0xa781, 0x6740, 0xa501, 0x65c0, 0x6480, 0xa441,
28 |         0x6c00, 0xacc1, 0xad81, 0x6d40, 0xaf01, 0x6fc0, 0x6e80, 0xae41,
29 |         0xaa01, 0x6ac0, 0x6b80, 0xab41, 0x6900, 0xa9c1, 0xa881, 0x6840,
30 |         0x7800, 0xb8c1, 0xb981, 0x7940, 0xbb01, 0x7bc0, 0x7a80, 0xba41,
31 |         0xbe01, 0x7ec0, 0x7f80, 0xbf41, 0x7d00, 0xbdc1, 0xbc81, 0x7c40,
32 |         0xb401, 0x74c0, 0x7580, 0xb541, 0x7700, 0xb7c1, 0xb681, 0x7640,
33 |         0x7200, 0xb2c1, 0xb381, 0x7340, 0xb101, 0x71c0, 0x7080, 0xb041,
34 |         0x5000, 0x90c1, 0x9181, 0x5140, 0x9301, 0x53c0, 0x5280, 0x9241,
35 |         0x9601, 0x56c0, 0x5780, 0x9741, 0x5500, 0x95c1, 0x9481, 0x5440,
36 |         0x9c01, 0x5cc0, 0x5d80, 0x9d41, 0x5f00, 0x9fc1, 0x9e81, 0x5e40,
37 |         0x5a00, 0x9ac1, 0x9b81, 0x5b40, 0x9901, 0x59c0, 0x5880, 0x9841,
38 |         0x8801, 0x48c0, 0x4980, 0x8941, 0x4b00, 0x8bc1, 0x8a81, 0x4a40,
39 |         0x4e00, 0x8ec1, 0x8f81, 0x4f40, 0x8d01, 0x4dc0, 0x4c80, 0x8c41,
40 |         0x4400, 0x84c1, 0x8581, 0x4540, 0x8701, 0x47c0, 0x4680, 0x8641,
41 |         0x8201, 0x42c0, 0x4380, 0x8341, 0x4100, 0x81c1, 0x8081, 0x4040
42 |     );
43 | 
44 |     public function update($data)
45 |     {
46 |         $len = strlen($data);
47 | 
48 |         for ($i = 0; $i < $len; $i++) {
49 |             $this->checksum = (($this->checksum >> 8) ^ $this->lookup[(ord($data[$i]) ^ $this->checksum) & 0xff]) & 0xffff;
50 |         }
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/src/CRC16CCITT.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | class CRC16CCITT extends CRC16
 6 | {
 7 |     protected $initChecksum = 0xffff;
 8 | 
 9 |     protected $lookup = array(
10 |         0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
11 |         0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
12 |         0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
13 |         0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
14 |         0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
15 |         0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
16 |         0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
17 |         0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
18 |         0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
19 |         0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
20 |         0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12,
21 |         0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
22 |         0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41,
23 |         0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
24 |         0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
25 |         0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
26 |         0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
27 |         0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
28 |         0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
29 |         0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
30 |         0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
31 |         0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
32 |         0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
33 |         0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
34 |         0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
35 |         0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3,
36 |         0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
37 |         0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
38 |         0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
39 |         0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
40 |         0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
41 |         0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
42 |     );
43 | 
44 |     public function update($data)
45 |     {
46 |         $len = strlen($data);
47 | 
48 |         for ($i = 0; $i < $len; $i++) {
49 |             $this->checksum = ($this->lookup[(($this->checksum >> 8) ^ ord($data[$i])) & 0xff] ^ ($this->checksum << 8)) & 0xffff;
50 |         }
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/src/CRC16DNP.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | class CRC16DNP extends CRC16
 6 | {
 7 |     protected $lookup = array(
 8 |         0x0000, 0x365e, 0x6cbc, 0x5ae2, 0xd978, 0xef26, 0xb5c4, 0x839a,
 9 |         0xff89, 0xc9d7, 0x9335, 0xa56b, 0x26f1, 0x10af, 0x4a4d, 0x7c13,
10 |         0xb26b, 0x8435, 0xded7, 0xe889, 0x6b13, 0x5d4d, 0x07af, 0x31f1,
11 |         0x4de2, 0x7bbc, 0x215e, 0x1700, 0x949a, 0xa2c4, 0xf826, 0xce78,
12 |         0x29af, 0x1ff1, 0x4513, 0x734d, 0xf0d7, 0xc689, 0x9c6b, 0xaa35,
13 |         0xd626, 0xe078, 0xba9a, 0x8cc4, 0x0f5e, 0x3900, 0x63e2, 0x55bc,
14 |         0x9bc4, 0xad9a, 0xf778, 0xc126, 0x42bc, 0x74e2, 0x2e00, 0x185e,
15 |         0x644d, 0x5213, 0x08f1, 0x3eaf, 0xbd35, 0x8b6b, 0xd189, 0xe7d7,
16 |         0x535e, 0x6500, 0x3fe2, 0x09bc, 0x8a26, 0xbc78, 0xe69a, 0xd0c4,
17 |         0xacd7, 0x9a89, 0xc06b, 0xf635, 0x75af, 0x43f1, 0x1913, 0x2f4d,
18 |         0xe135, 0xd76b, 0x8d89, 0xbbd7, 0x384d, 0x0e13, 0x54f1, 0x62af,
19 |         0x1ebc, 0x28e2, 0x7200, 0x445e, 0xc7c4, 0xf19a, 0xab78, 0x9d26,
20 |         0x7af1, 0x4caf, 0x164d, 0x2013, 0xa389, 0x95d7, 0xcf35, 0xf96b,
21 |         0x8578, 0xb326, 0xe9c4, 0xdf9a, 0x5c00, 0x6a5e, 0x30bc, 0x06e2,
22 |         0xc89a, 0xfec4, 0xa426, 0x9278, 0x11e2, 0x27bc, 0x7d5e, 0x4b00,
23 |         0x3713, 0x014d, 0x5baf, 0x6df1, 0xee6b, 0xd835, 0x82d7, 0xb489,
24 |         0xa6bc, 0x90e2, 0xca00, 0xfc5e, 0x7fc4, 0x499a, 0x1378, 0x2526,
25 |         0x5935, 0x6f6b, 0x3589, 0x03d7, 0x804d, 0xb613, 0xecf1, 0xdaaf,
26 |         0x14d7, 0x2289, 0x786b, 0x4e35, 0xcdaf, 0xfbf1, 0xa113, 0x974d,
27 |         0xeb5e, 0xdd00, 0x87e2, 0xb1bc, 0x3226, 0x0478, 0x5e9a, 0x68c4,
28 |         0x8f13, 0xb94d, 0xe3af, 0xd5f1, 0x566b, 0x6035, 0x3ad7, 0x0c89,
29 |         0x709a, 0x46c4, 0x1c26, 0x2a78, 0xa9e2, 0x9fbc, 0xc55e, 0xf300,
30 |         0x3d78, 0x0b26, 0x51c4, 0x679a, 0xe400, 0xd25e, 0x88bc, 0xbee2,
31 |         0xc2f1, 0xf4af, 0xae4d, 0x9813, 0x1b89, 0x2dd7, 0x7735, 0x416b,
32 |         0xf5e2, 0xc3bc, 0x995e, 0xaf00, 0x2c9a, 0x1ac4, 0x4026, 0x7678,
33 |         0x0a6b, 0x3c35, 0x66d7, 0x5089, 0xd313, 0xe54d, 0xbfaf, 0x89f1,
34 |         0x4789, 0x71d7, 0x2b35, 0x1d6b, 0x9ef1, 0xa8af, 0xf24d, 0xc413,
35 |         0xb800, 0x8e5e, 0xd4bc, 0xe2e2, 0x6178, 0x5726, 0x0dc4, 0x3b9a,
36 |         0xdc4d, 0xea13, 0xb0f1, 0x86af, 0x0535, 0x336b, 0x6989, 0x5fd7,
37 |         0x23c4, 0x159a, 0x4f78, 0x7926, 0xfabc, 0xcce2, 0x9600, 0xa05e,
38 |         0x6e26, 0x5878, 0x029a, 0x34c4, 0xb75e, 0x8100, 0xdbe2, 0xedbc,
39 |         0x91af, 0xa7f1, 0xfd13, 0xcb4d, 0x48d7, 0x7e89, 0x246b, 0x1235
40 |     );
41 | 
42 |     public function update($data)
43 |     {
44 |         $len = strlen($data);
45 | 
46 |         for ($i = 0; $i < $len; $i++) {
47 |             $this->checksum = ($this->checksum >> 8) ^ $this->lookup[($this->checksum ^ ord($data[$i])) & 0xff];
48 |         }
49 |     }
50 | 
51 |     public function finish()
52 |     {
53 |         return $this->pack(~$this->checksum);
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/src/CRC16.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace mermshaus\CRC;
 4 | 
 5 | class CRC16 extends AbstractCRC
 6 | {
 7 |     protected $lookup = array(
 8 |         0x0000, 0xc0c1, 0xc181, 0x0140, 0xc301, 0x03c0, 0x0280, 0xc241,
 9 |         0xc601, 0x06c0, 0x0780, 0xc741, 0x0500, 0xc5c1, 0xc481, 0x0440,
10 |         0xcc01, 0x0cc0, 0x0d80, 0xcd41, 0x0f00, 0xcfc1, 0xce81, 0x0e40,
11 |         0x0a00, 0xcac1, 0xcb81, 0x0b40, 0xc901, 0x09c0, 0x0880, 0xc841,
12 |         0xd801, 0x18c0, 0x1980, 0xd941, 0x1b00, 0xdbc1, 0xda81, 0x1a40,
13 |         0x1e00, 0xdec1, 0xdf81, 0x1f40, 0xdd01, 0x1dc0, 0x1c80, 0xdc41,
14 |         0x1400, 0xd4c1, 0xd581, 0x1540, 0xd701, 0x17c0, 0x1680, 0xd641,
15 |         0xd201, 0x12c0, 0x1380, 0xd341, 0x1100, 0xd1c1, 0xd081, 0x1040,
16 |         0xf001, 0x30c0, 0x3180, 0xf141, 0x3300, 0xf3c1, 0xf281, 0x3240,
17 |         0x3600, 0xf6c1, 0xf781, 0x3740, 0xf501, 0x35c0, 0x3480, 0xf441,
18 |         0x3c00, 0xfcc1, 0xfd81, 0x3d40, 0xff01, 0x3fc0, 0x3e80, 0xfe41,
19 |         0xfa01, 0x3ac0, 0x3b80, 0xfb41, 0x3900, 0xf9c1, 0xf881, 0x3840,
20 |         0x2800, 0xe8c1, 0xe981, 0x2940, 0xeb01, 0x2bc0, 0x2a80, 0xea41,
21 |         0xee01, 0x2ec0, 0x2f80, 0xef41, 0x2d00, 0xedc1, 0xec81, 0x2c40,
22 |         0xe401, 0x24c0, 0x2580, 0xe541, 0x2700, 0xe7c1, 0xe681, 0x2640,
23 |         0x2200, 0xe2c1, 0xe381, 0x2340, 0xe101, 0x21c0, 0x2080, 0xe041,
24 |         0xa001, 0x60c0, 0x6180, 0xa141, 0x6300, 0xa3c1, 0xa281, 0x6240,
25 |         0x6600, 0xa6c1, 0xa781, 0x6740, 0xa501, 0x65c0, 0x6480, 0xa441,
26 |         0x6c00, 0xacc1, 0xad81, 0x6d40, 0xaf01, 0x6fc0, 0x6e80, 0xae41,
27 |         0xaa01, 0x6ac0, 0x6b80, 0xab41, 0x6900, 0xa9c1, 0xa881, 0x6840,
28 |         0x7800, 0xb8c1, 0xb981, 0x7940, 0xbb01, 0x7bc0, 0x7a80, 0xba41,
29 |         0xbe01, 0x7ec0, 0x7f80, 0xbf41, 0x7d00, 0xbdc1, 0xbc81, 0x7c40,
30 |         0xb401, 0x74c0, 0x7580, 0xb541, 0x7700, 0xb7c1, 0xb681, 0x7640,
31 |         0x7200, 0xb2c1, 0xb381, 0x7340, 0xb101, 0x71c0, 0x7080, 0xb041,
32 |         0x5000, 0x90c1, 0x9181, 0x5140, 0x9301, 0x53c0, 0x5280, 0x9241,
33 |         0x9601, 0x56c0, 0x5780, 0x9741, 0x5500, 0x95c1, 0x9481, 0x5440,
34 |         0x9c01, 0x5cc0, 0x5d80, 0x9d41, 0x5f00, 0x9fc1, 0x9e81, 0x5e40,
35 |         0x5a00, 0x9ac1, 0x9b81, 0x5b40, 0x9901, 0x59c0, 0x5880, 0x9841,
36 |         0x8801, 0x48c0, 0x4980, 0x8941, 0x4b00, 0x8bc1, 0x8a81, 0x4a40,
37 |         0x4e00, 0x8ec1, 0x8f81, 0x4f40, 0x8d01, 0x4dc0, 0x4c80, 0x8c41,
38 |         0x4400, 0x84c1, 0x8581, 0x4540, 0x8701, 0x47c0, 0x4680, 0x8641,
39 |         0x8201, 0x42c0, 0x4380, 0x8341, 0x4100, 0x81c1, 0x8081, 0x4040
40 |     );
41 | 
42 |     public function pack($checksum)
43 |     {
44 |         return pack('n', $checksum);
45 |     }
46 | 
47 |     public function update($data)
48 |     {
49 |         $len = strlen($data);
50 | 
51 |         for ($i = 0; $i < $len; $i++) {
52 |             $this->checksum = ($this->lookup[($this->checksum ^ ord($data[$i])) & 0xff] ^ ($this->checksum >> 8)) & 0xffff;
53 |         }
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/tests/CRCSuiteTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace mermshaus\CRC\Tests;
  4 | 
  5 | use mermshaus\CRC\CRC1;
  6 | use mermshaus\CRC\CRC16;
  7 | use mermshaus\CRC\CRC16CCITT;
  8 | use mermshaus\CRC\CRC16DNP;
  9 | use mermshaus\CRC\CRC16Modbus;
 10 | use mermshaus\CRC\CRC16QT;
 11 | use mermshaus\CRC\CRC16USB;
 12 | use mermshaus\CRC\CRC16XModem;
 13 | use mermshaus\CRC\CRC16ZModem;
 14 | use mermshaus\CRC\CRCInterface;
 15 | use PHPUnit_Framework_TestCase;
 16 | 
 17 | /**
 18 |  *
 19 |  */
 20 | class CRCSuiteTest extends PHPUnit_Framework_TestCase
 21 | {
 22 |     /**
 23 |      *
 24 |      * @param string $string
 25 |      * @return string
 26 |      */
 27 |     protected function strToHex($string)
 28 |     {
 29 |         $hex = '';
 30 |         $len = strlen($string);
 31 | 
 32 |         for ($i = 0; $i < $len; $i++) {
 33 |             $ord = ord($string[$i]);
 34 |             $hex .= (($ord >> 4) ? dechex($ord) : '0' . dechex($ord));
 35 |         }
 36 | 
 37 |         return $hex;
 38 |     }
 39 | 
 40 |     /**
 41 |      * @dataProvider providerAlgorithmsWork
 42 |      */
 43 |     public function testAlgorithmsWork(
 44 |         CRCInterface $obj,
 45 |         $data,
 46 |         $expected
 47 |     ) {
 48 |         $chunkSize = 1;
 49 | 
 50 |         foreach (str_split($data, $chunkSize) as $byte) {
 51 |             $obj->update($byte);
 52 |         }
 53 | 
 54 |         $this->assertEquals($expected, $this->strToHex($obj->finish()));
 55 | 
 56 |         // Reset and test again
 57 | 
 58 |         $obj->reset();
 59 | 
 60 |         foreach (str_split($data, $chunkSize) as $byte) {
 61 |             $obj->update($byte);
 62 |         }
 63 | 
 64 |         $this->assertEquals($expected, $this->strToHex($obj->finish()));
 65 | 
 66 |         // Reset and test again with different $chunkSize
 67 | 
 68 |         $obj->reset();
 69 |         $chunkSize = 3;
 70 | 
 71 |         foreach (str_split($data, $chunkSize) as $byte) {
 72 |             $obj->update($byte);
 73 |         }
 74 | 
 75 |         $this->assertEquals($expected, $this->strToHex($obj->finish()));
 76 |     }
 77 | 
 78 |     /**
 79 |      *
 80 |      * @return array
 81 |      */
 82 |     public function providerAlgorithmsWork()
 83 |     {
 84 |         $tests = array();
 85 | 
 86 |         $data = '1234567890';
 87 | 
 88 |         $tests[] = array(new CRC1(),        $data,   '0d');
 89 |         $tests[] = array(new CRC16(),       $data, 'c57a');
 90 |         $tests[] = array(new CRC16CCITT(),  $data, '3218');
 91 |         $tests[] = array(new CRC16DNP(),    $data, '1bbc');
 92 |         $tests[] = array(new CRC16Modbus(), $data, 'c20a');
 93 |         $tests[] = array(new CRC16QT(),     $data, '4b13');
 94 |         $tests[] = array(new CRC16USB(),    $data, '3df5');
 95 |         $tests[] = array(new CRC16XModem(), $data, 'd321');
 96 |         $tests[] = array(new CRC16ZModem(), $data, 'd321');
 97 | 
 98 |         $data = 'test';
 99 | 
100 |         $tests[] = array(new CRC1(),        $data,   'c0');
101 |         $tests[] = array(new CRC16(),       $data, 'f82e');
102 |         $tests[] = array(new CRC16CCITT(),  $data, '1fc6');
103 |         $tests[] = array(new CRC16DNP(),    $data, '75b4');
104 |         $tests[] = array(new CRC16Modbus(), $data, 'dc2e');
105 |         //$tests[] = array(new CRC16QT(),     $data, '4b13');
106 |         //$tests[] = array(new CRC16USB(),    $data, '3df5');
107 |         $tests[] = array(new CRC16XModem(), $data, '9b06');
108 |         //$tests[] = array(new CRC16ZModem(), $data, 'd321');
109 | 
110 |         return $tests;
111 |     }
112 | }
113 | 


--------------------------------------------------------------------------------