1 /*- 2 * This file is provided under a dual BSD/GPLv2 license. When using or 3 * redistributing this file, you may do so under either license. 4 * 5 * BSD LICENSE 6 * 7 * Copyright 2011 Freescale Semiconductor, Inc. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions are met: 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * * Neither the name of the above-listed copyright holders nor the 17 * names of any contributors may be used to endorse or promote products 18 * derived from this software without specific prior written permission. 19 * 20 * GPL LICENSE SUMMARY 21 * 22 * ALTERNATIVELY, this software may be distributed under the terms of the 23 * GNU General Public License ("GPL") as published by the Free Software 24 * Foundation, either version 2 of that License or (at your option) any 25 * later version. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 28 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE 31 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 #ifndef __FSL_FMAN_CRC64_H 41 #define __FSL_FMAN_CRC64_H 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 /* 48 * This following definitions provide a software implementation of the CRC64 49 * algorithm implemented within Fman. 50 * 51 * The following example shows how to compute a CRC64 hash value based on 52 * SRC_IP, DST_IP and ESP_SPI values 53 * 54 * #define compute_hash(saddr,daddr,spi) \ 55 * do { \ 56 * uint64_t result; \ 57 * result = fman_crc64_init(); \ 58 * result = fman_crc64_compute_32bit(saddr, result); \ 59 * result = fman_crc64_compute_32bit(daddr, result); \ 60 * result = fman_crc64_compute_32bit(spi, result); \ 61 * return (uint32_t) result & RC_HASH_MASK; \ 62 * } while (0); 63 * 64 * If hashing over a different number of fields (or of different types) is 65 * required, this can be implemented using the following primitives. 66 */ 67 68 /* The following table provides the constants used by the Fman CRC64 69 * implementation. The table is instantiated within the DPAA fman driver. 70 * However if the application is not going to be linked against the DPAA fman 71 * driver but will use this Fman CRC64 implementation, then it will need to 72 * instantiate this table by using the DECLARE_FMAN_CRC64_TABLE() macro. 73 */ 74 struct fman_crc64_t { 75 uint64_t initial; 76 uint64_t table[1 << 8]; 77 }; 78 extern struct fman_crc64_t FMAN_CRC64_ECMA_182; 79 #define DECLARE_FMAN_CRC64_TABLE() \ 80 struct fman_crc64_t FMAN_CRC64_ECMA_182 = { \ 81 0xFFFFFFFFFFFFFFFFULL, \ 82 { \ 83 0x0000000000000000ULL, 0xb32e4cbe03a75f6fULL, \ 84 0xf4843657a840a05bULL, 0x47aa7ae9abe7ff34ULL, \ 85 0x7bd0c384ff8f5e33ULL, 0xc8fe8f3afc28015cULL, \ 86 0x8f54f5d357cffe68ULL, 0x3c7ab96d5468a107ULL, \ 87 0xf7a18709ff1ebc66ULL, 0x448fcbb7fcb9e309ULL, \ 88 0x0325b15e575e1c3dULL, 0xb00bfde054f94352ULL, \ 89 0x8c71448d0091e255ULL, 0x3f5f08330336bd3aULL, \ 90 0x78f572daa8d1420eULL, 0xcbdb3e64ab761d61ULL, \ 91 0x7d9ba13851336649ULL, 0xceb5ed8652943926ULL, \ 92 0x891f976ff973c612ULL, 0x3a31dbd1fad4997dULL, \ 93 0x064b62bcaebc387aULL, 0xb5652e02ad1b6715ULL, \ 94 0xf2cf54eb06fc9821ULL, 0x41e11855055bc74eULL, \ 95 0x8a3a2631ae2dda2fULL, 0x39146a8fad8a8540ULL, \ 96 0x7ebe1066066d7a74ULL, 0xcd905cd805ca251bULL, \ 97 0xf1eae5b551a2841cULL, 0x42c4a90b5205db73ULL, \ 98 0x056ed3e2f9e22447ULL, 0xb6409f5cfa457b28ULL, \ 99 0xfb374270a266cc92ULL, 0x48190ecea1c193fdULL, \ 100 0x0fb374270a266cc9ULL, 0xbc9d3899098133a6ULL, \ 101 0x80e781f45de992a1ULL, 0x33c9cd4a5e4ecdceULL, \ 102 0x7463b7a3f5a932faULL, 0xc74dfb1df60e6d95ULL, \ 103 0x0c96c5795d7870f4ULL, 0xbfb889c75edf2f9bULL, \ 104 0xf812f32ef538d0afULL, 0x4b3cbf90f69f8fc0ULL, \ 105 0x774606fda2f72ec7ULL, 0xc4684a43a15071a8ULL, \ 106 0x83c230aa0ab78e9cULL, 0x30ec7c140910d1f3ULL, \ 107 0x86ace348f355aadbULL, 0x3582aff6f0f2f5b4ULL, \ 108 0x7228d51f5b150a80ULL, 0xc10699a158b255efULL, \ 109 0xfd7c20cc0cdaf4e8ULL, 0x4e526c720f7dab87ULL, \ 110 0x09f8169ba49a54b3ULL, 0xbad65a25a73d0bdcULL, \ 111 0x710d64410c4b16bdULL, 0xc22328ff0fec49d2ULL, \ 112 0x85895216a40bb6e6ULL, 0x36a71ea8a7ace989ULL, \ 113 0x0adda7c5f3c4488eULL, 0xb9f3eb7bf06317e1ULL, \ 114 0xfe5991925b84e8d5ULL, 0x4d77dd2c5823b7baULL, \ 115 0x64b62bcaebc387a1ULL, 0xd7986774e864d8ceULL, \ 116 0x90321d9d438327faULL, 0x231c512340247895ULL, \ 117 0x1f66e84e144cd992ULL, 0xac48a4f017eb86fdULL, \ 118 0xebe2de19bc0c79c9ULL, 0x58cc92a7bfab26a6ULL, \ 119 0x9317acc314dd3bc7ULL, 0x2039e07d177a64a8ULL, \ 120 0x67939a94bc9d9b9cULL, 0xd4bdd62abf3ac4f3ULL, \ 121 0xe8c76f47eb5265f4ULL, 0x5be923f9e8f53a9bULL, \ 122 0x1c4359104312c5afULL, 0xaf6d15ae40b59ac0ULL, \ 123 0x192d8af2baf0e1e8ULL, 0xaa03c64cb957be87ULL, \ 124 0xeda9bca512b041b3ULL, 0x5e87f01b11171edcULL, \ 125 0x62fd4976457fbfdbULL, 0xd1d305c846d8e0b4ULL, \ 126 0x96797f21ed3f1f80ULL, 0x2557339fee9840efULL, \ 127 0xee8c0dfb45ee5d8eULL, 0x5da24145464902e1ULL, \ 128 0x1a083bacedaefdd5ULL, 0xa9267712ee09a2baULL, \ 129 0x955cce7fba6103bdULL, 0x267282c1b9c65cd2ULL, \ 130 0x61d8f8281221a3e6ULL, 0xd2f6b4961186fc89ULL, \ 131 0x9f8169ba49a54b33ULL, 0x2caf25044a02145cULL, \ 132 0x6b055fede1e5eb68ULL, 0xd82b1353e242b407ULL, \ 133 0xe451aa3eb62a1500ULL, 0x577fe680b58d4a6fULL, \ 134 0x10d59c691e6ab55bULL, 0xa3fbd0d71dcdea34ULL, \ 135 0x6820eeb3b6bbf755ULL, 0xdb0ea20db51ca83aULL, \ 136 0x9ca4d8e41efb570eULL, 0x2f8a945a1d5c0861ULL, \ 137 0x13f02d374934a966ULL, 0xa0de61894a93f609ULL, \ 138 0xe7741b60e174093dULL, 0x545a57dee2d35652ULL, \ 139 0xe21ac88218962d7aULL, 0x5134843c1b317215ULL, \ 140 0x169efed5b0d68d21ULL, 0xa5b0b26bb371d24eULL, \ 141 0x99ca0b06e7197349ULL, 0x2ae447b8e4be2c26ULL, \ 142 0x6d4e3d514f59d312ULL, 0xde6071ef4cfe8c7dULL, \ 143 0x15bb4f8be788911cULL, 0xa6950335e42fce73ULL, \ 144 0xe13f79dc4fc83147ULL, 0x521135624c6f6e28ULL, \ 145 0x6e6b8c0f1807cf2fULL, 0xdd45c0b11ba09040ULL, \ 146 0x9aefba58b0476f74ULL, 0x29c1f6e6b3e0301bULL, \ 147 0xc96c5795d7870f42ULL, 0x7a421b2bd420502dULL, \ 148 0x3de861c27fc7af19ULL, 0x8ec62d7c7c60f076ULL, \ 149 0xb2bc941128085171ULL, 0x0192d8af2baf0e1eULL, \ 150 0x4638a2468048f12aULL, 0xf516eef883efae45ULL, \ 151 0x3ecdd09c2899b324ULL, 0x8de39c222b3eec4bULL, \ 152 0xca49e6cb80d9137fULL, 0x7967aa75837e4c10ULL, \ 153 0x451d1318d716ed17ULL, 0xf6335fa6d4b1b278ULL, \ 154 0xb199254f7f564d4cULL, 0x02b769f17cf11223ULL, \ 155 0xb4f7f6ad86b4690bULL, 0x07d9ba1385133664ULL, \ 156 0x4073c0fa2ef4c950ULL, 0xf35d8c442d53963fULL, \ 157 0xcf273529793b3738ULL, 0x7c0979977a9c6857ULL, \ 158 0x3ba3037ed17b9763ULL, 0x888d4fc0d2dcc80cULL, \ 159 0x435671a479aad56dULL, 0xf0783d1a7a0d8a02ULL, \ 160 0xb7d247f3d1ea7536ULL, 0x04fc0b4dd24d2a59ULL, \ 161 0x3886b22086258b5eULL, 0x8ba8fe9e8582d431ULL, \ 162 0xcc0284772e652b05ULL, 0x7f2cc8c92dc2746aULL, \ 163 0x325b15e575e1c3d0ULL, 0x8175595b76469cbfULL, \ 164 0xc6df23b2dda1638bULL, 0x75f16f0cde063ce4ULL, \ 165 0x498bd6618a6e9de3ULL, 0xfaa59adf89c9c28cULL, \ 166 0xbd0fe036222e3db8ULL, 0x0e21ac88218962d7ULL, \ 167 0xc5fa92ec8aff7fb6ULL, 0x76d4de52895820d9ULL, \ 168 0x317ea4bb22bfdfedULL, 0x8250e80521188082ULL, \ 169 0xbe2a516875702185ULL, 0x0d041dd676d77eeaULL, \ 170 0x4aae673fdd3081deULL, 0xf9802b81de97deb1ULL, \ 171 0x4fc0b4dd24d2a599ULL, 0xfceef8632775faf6ULL, \ 172 0xbb44828a8c9205c2ULL, 0x086ace348f355aadULL, \ 173 0x34107759db5dfbaaULL, 0x873e3be7d8faa4c5ULL, \ 174 0xc094410e731d5bf1ULL, 0x73ba0db070ba049eULL, \ 175 0xb86133d4dbcc19ffULL, 0x0b4f7f6ad86b4690ULL, \ 176 0x4ce50583738cb9a4ULL, 0xffcb493d702be6cbULL, \ 177 0xc3b1f050244347ccULL, 0x709fbcee27e418a3ULL, \ 178 0x3735c6078c03e797ULL, 0x841b8ab98fa4b8f8ULL, \ 179 0xadda7c5f3c4488e3ULL, 0x1ef430e13fe3d78cULL, \ 180 0x595e4a08940428b8ULL, 0xea7006b697a377d7ULL, \ 181 0xd60abfdbc3cbd6d0ULL, 0x6524f365c06c89bfULL, \ 182 0x228e898c6b8b768bULL, 0x91a0c532682c29e4ULL, \ 183 0x5a7bfb56c35a3485ULL, 0xe955b7e8c0fd6beaULL, \ 184 0xaeffcd016b1a94deULL, 0x1dd181bf68bdcbb1ULL, \ 185 0x21ab38d23cd56ab6ULL, 0x9285746c3f7235d9ULL, \ 186 0xd52f0e859495caedULL, 0x6601423b97329582ULL, \ 187 0xd041dd676d77eeaaULL, 0x636f91d96ed0b1c5ULL, \ 188 0x24c5eb30c5374ef1ULL, 0x97eba78ec690119eULL, \ 189 0xab911ee392f8b099ULL, 0x18bf525d915feff6ULL, \ 190 0x5f1528b43ab810c2ULL, 0xec3b640a391f4fadULL, \ 191 0x27e05a6e926952ccULL, 0x94ce16d091ce0da3ULL, \ 192 0xd3646c393a29f297ULL, 0x604a2087398eadf8ULL, \ 193 0x5c3099ea6de60cffULL, 0xef1ed5546e415390ULL, \ 194 0xa8b4afbdc5a6aca4ULL, 0x1b9ae303c601f3cbULL, \ 195 0x56ed3e2f9e224471ULL, 0xe5c372919d851b1eULL, \ 196 0xa26908783662e42aULL, 0x114744c635c5bb45ULL, \ 197 0x2d3dfdab61ad1a42ULL, 0x9e13b115620a452dULL, \ 198 0xd9b9cbfcc9edba19ULL, 0x6a978742ca4ae576ULL, \ 199 0xa14cb926613cf817ULL, 0x1262f598629ba778ULL, \ 200 0x55c88f71c97c584cULL, 0xe6e6c3cfcadb0723ULL, \ 201 0xda9c7aa29eb3a624ULL, 0x69b2361c9d14f94bULL, \ 202 0x2e184cf536f3067fULL, 0x9d36004b35545910ULL, \ 203 0x2b769f17cf112238ULL, 0x9858d3a9ccb67d57ULL, \ 204 0xdff2a94067518263ULL, 0x6cdce5fe64f6dd0cULL, \ 205 0x50a65c93309e7c0bULL, 0xe388102d33392364ULL, \ 206 0xa4226ac498dedc50ULL, 0x170c267a9b79833fULL, \ 207 0xdcd7181e300f9e5eULL, 0x6ff954a033a8c131ULL, \ 208 0x28532e49984f3e05ULL, 0x9b7d62f79be8616aULL, \ 209 0xa707db9acf80c06dULL, 0x14299724cc279f02ULL, \ 210 0x5383edcd67c06036ULL, 0xe0ada17364673f59ULL} \ 211 } 212 213 /* 214 * Return the initial CRC seed. Use the value returned from this API as the 215 * "crc" parameter to the first call to add data. 216 */ 217 static inline uint64_t fman_crc64_init(void) 218 { 219 return FMAN_CRC64_ECMA_182.initial; 220 } 221 222 /* Updates the CRC with arbitrary data */ 223 static inline uint64_t fman_crc64_update(uint64_t crc, 224 void *data, unsigned int len) 225 { 226 uint8_t *p = data; 227 while (len--) 228 crc = FMAN_CRC64_ECMA_182.table[(crc ^ *(p++)) & 0xff] ^ 229 (crc >> 8); 230 return crc; 231 } 232 233 /* Shorthands for updating the CRC with 8/16/32 bits of data. 234 * IMPORTANT NOTE: the typed "data" arguments should not be mistaken for 235 * host-endian numerical values, the assumption is that these values contain 236 * big-endian (ie. network byte order) data. 237 */ 238 static inline uint64_t fman_crc64_compute_32bit(uint32_t data, uint64_t crc) 239 { 240 return fman_crc64_update(crc, &data, sizeof(data)); 241 } 242 static inline uint64_t fman_crc64_compute_16bit(uint16_t data, uint64_t crc) 243 { 244 return fman_crc64_update(crc, &data, sizeof(data)); 245 } 246 static inline uint64_t fman_crc64_compute_8bit(uint8_t data, uint64_t crc) 247 { 248 return fman_crc64_update(crc, &data, sizeof(data)); 249 } 250 251 /* 252 * Finalise the CRC (using 2's complement) 253 */ 254 static inline uint64_t fman_crc64_finish(uint64_t seed) 255 { 256 return ~seed; 257 } 258 259 #ifdef __cplusplus 260 } 261 #endif 262 263 #endif /* __FSL_FMAN_CRC64_H */ 264