← Back to branch summary

~ubuntu-branches/ubuntu/trusty/linux-armadaxp/trusty

« back to all changes in this revision

Viewing changes to include/linux/crc8.h

  • Committer: Package Import Robot
  • Author(s): Michael Casadevall, Bryan Wu, Dann Frazier, Michael Casadeall
  • Date: 2012-03-10 15:00:54 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20120310150054-flugb39zon8vvgwe
Tags: 3.2.0-1600.1
[ Bryan Wu ]
* UBUNTU: import debian/debian.env and debian.armadaxp

[ Dann Frazier ]
* ARM: Armada XP: remove trailing '/' in dirnames in mvRules.mk

[ Michael Casadeall ]
* tools: add some tools for Marvell Armada XP processor
* kernel: timer tick hacking from Marvell
* kernel: Sheeva Errata: add delay on Sheeva when powering down
* net: add Marvell NFP netfilter
* net: socket and skb modifications made by Marvell
* miscdevice: add minor IDs for some Marvell Armada drivers
* fs: introduce memory pool for splice()
* video: EDID detection updates from Marvell Armada XP patchset
* video: backlight: add Marvell Dove LCD backlight driver
* video: display: add THS8200 display driver
* video: framebuffer: add Marvell Dove and Armada XP processor onchip LCD controller driver
* usbtest: add Interrupt transfer testing by Marvell Armada XP code
* usb: ehci: add support for Marvell EHCI controler
* tty/serial: 8250: add support for Marvell Armada XP processor and DeviceTree work
* rtc: add support for Marvell Armada XP onchip RTC controller
* net: pppoe: add Marvell ethernet NFP hook in PPPoE networking driver
* mtd: nand: add support for Marvell Armada XP Nand Flash Controller
* mtd: maps: add Marvell Armada XP specific map driver
* mmc: add support for Marvell Armada XP MMC/SD host controller
* i2c: add support for Marvell Armada XP onchip i2c bus controller
* hwmon: add Kconfig option for Armada XP onchip thermal sensor driver
* dmaengine: add Net DMA support for splice and update Marvell XOR DMA engine driver
* ata: add support for Marvell Armada XP SATA controller and update some quirks
* ARM: add Marvell Armada XP machine to mach-types
* ARM: oprofile: add support for Marvell PJ4B core
* ARM: mm: more ARMv6 switches for Marvell Armada XP
* ARM: remove static declaration to allow compilation
* ARM: alignment access fault trick
* ARM: mm: skip some fault fixing when run on NONE SMP ARMv6 mode during early abort event
* ARM: mm: add Marvell Sheeva CPU Architecture for PJ4B
* ARM: introduce optimized copy operation for Marvell Armada XP
* ARM: SAUCE: hardware breakpoint trick for Marvell Armada XP
* ARM: big endian and little endian tricks for Marvell Armada XP
* ARM: SAUCE: Add Marvell Armada XP build rules to arch/arm/kernel/Makefile
* ARM: vfp: add special handling for Marvell Armada XP
* ARM: add support for Marvell U-Boot
* ARM: add mv_controller_num for ARM PCI drivers
* ARM: add support for local PMUs, general SMP tweaks and cache flushing
* ARM: add Marvell device identifies in glue-proc.h
* ARM: add IPC driver support for Marvell platforms
* ARM: add DMA mapping for Marvell platforms
* ARM: add Sheeva errata and PJ4B code for booting
* ARM: update Kconfig and Makefile to include Marvell Armada XP platforms
* ARM: Armada XP: import LSP from Marvell for Armada XP 3.2 kernel enablement

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/linux/crc8.h
 
1
/*
 
2
 * Copyright (c) 2011 Broadcom Corporation
 
3
 *
 
4
 * Permission to use, copy, modify, and/or distribute this software for any
 
5
 * purpose with or without fee is hereby granted, provided that the above
 
6
 * copyright notice and this permission notice appear in all copies.
 
7
 *
 
8
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 
9
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 
10
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 
11
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 
12
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
 
13
 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 
14
 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
15
 */
 
16
#ifndef __CRC8_H_
 
17
#define __CRC8_H_
 
18
 
 
19
#include <linux/types.h>
 
20
 
 
21
/* see usage of this value in crc8() description */
 
22
#define CRC8_INIT_VALUE         0xFF
 
23
 
 
24
/*
 
25
 * Return value of crc8() indicating valid message+crc. This is true
 
26
 * if a CRC is inverted before transmission. The CRC computed over the
 
27
 * whole received bitstream is _table[x], where x is the bit pattern
 
28
 * of the modification (almost always 0xff).
 
29
 */
 
30
#define CRC8_GOOD_VALUE(_table) (_table[0xFF])
 
31
 
 
32
/* required table size for crc8 algorithm */
 
33
#define CRC8_TABLE_SIZE                 256
 
34
 
 
35
/* helper macro assuring right table size is used */
 
36
#define DECLARE_CRC8_TABLE(_table) \
 
37
        static u8 _table[CRC8_TABLE_SIZE]
 
38
 
 
39
/**
 
40
 * crc8_populate_lsb - fill crc table for given polynomial in regular bit order.
 
41
 *
 
42
 * @table:      table to be filled.
 
43
 * @polynomial: polynomial for which table is to be filled.
 
44
 *
 
45
 * This function fills the provided table according the polynomial provided for
 
46
 * regular bit order (lsb first). Polynomials in CRC algorithms are typically
 
47
 * represented as shown below.
 
48
 *
 
49
 *      poly = x^8 + x^7 + x^6 + x^4 + x^2 + 1
 
50
 *
 
51
 * For lsb first direction x^7 maps to the lsb. So the polynomial is as below.
 
52
 *
 
53
 * - lsb first: poly = 10101011(1) = 0xAB
 
54
 */
 
55
void crc8_populate_lsb(u8 table[CRC8_TABLE_SIZE], u8 polynomial);
 
56
 
 
57
/**
 
58
 * crc8_populate_msb - fill crc table for given polynomial in reverse bit order.
 
59
 *
 
60
 * @table:      table to be filled.
 
61
 * @polynomial: polynomial for which table is to be filled.
 
62
 *
 
63
 * This function fills the provided table according the polynomial provided for
 
64
 * reverse bit order (msb first). Polynomials in CRC algorithms are typically
 
65
 * represented as shown below.
 
66
 *
 
67
 *      poly = x^8 + x^7 + x^6 + x^4 + x^2 + 1
 
68
 *
 
69
 * For msb first direction x^7 maps to the msb. So the polynomial is as below.
 
70
 *
 
71
 * - msb first: poly = (1)11010101 = 0xD5
 
72
 */
 
73
void crc8_populate_msb(u8 table[CRC8_TABLE_SIZE], u8 polynomial);
 
74
 
 
75
/**
 
76
 * crc8() - calculate a crc8 over the given input data.
 
77
 *
 
78
 * @table:      crc table used for calculation.
 
79
 * @pdata:      pointer to data buffer.
 
80
 * @nbytes:     number of bytes in data buffer.
 
81
 * @crc:        previous returned crc8 value.
 
82
 *
 
83
 * The CRC8 is calculated using the polynomial given in crc8_populate_msb()
 
84
 * or crc8_populate_lsb().
 
85
 *
 
86
 * The caller provides the initial value (either %CRC8_INIT_VALUE
 
87
 * or the previous returned value) to allow for processing of
 
88
 * discontiguous blocks of data.  When generating the CRC the
 
89
 * caller is responsible for complementing the final return value
 
90
 * and inserting it into the byte stream.  When validating a byte
 
91
 * stream (including CRC8), a final return value of %CRC8_GOOD_VALUE
 
92
 * indicates the byte stream data can be considered valid.
 
93
 *
 
94
 * Reference:
 
95
 * "A Painless Guide to CRC Error Detection Algorithms", ver 3, Aug 1993
 
96
 * Williams, Ross N., ross<at>ross.net
 
97
 * (see URL http://www.ross.net/crc/download/crc_v3.txt).
 
98
 */
 
99
u8 crc8(const u8 table[CRC8_TABLE_SIZE], u8 *pdata, size_t nbytes, u8 crc);
 
100
 
 
101
#endif /* __CRC8_H_ */