crc.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

/**
 * @file crc.h
 * @brief ROHC CRC routines
 * @author Didier Barvaux <didier.barvaux@toulouse.viveris.com>
 * @author The hackers from ROHC for Linux
 * @author Didier Barvaux <didier@barvaux.org>
 */

#ifndef CRC_H
#define CRC_H

#include "ip.h"

#include <stdbool.h>

/// The CRC-2 initial value
#define CRC_INIT_2 0x3
/// The CRC-3 initial value
#define CRC_INIT_3 0x7
/// The CRC-6 initial value
#define CRC_INIT_6 0x3f
/// The CRC-7 initial value
#define CRC_INIT_7 0x7f
/// The CRC-8 initial value
#define CRC_INIT_8 0xff


/*
 * Function prototypes.
 */

bool rohc_crc_init_table(unsigned char *const table, const int crc_type)
        __attribute__((nonnull(1), warn_unused_result));

unsigned int crc_calculate(const int crc_type,
                           const unsigned char *const data,
                           const int length,
                           const unsigned int init_val,
                           const unsigned char *const crc_table)
        __attribute__((nonnull(2, 5)));

unsigned int compute_crc_static(const unsigned char *const ip,
                                const unsigned char *const ip2,
                                const unsigned char *const next_header,
                                const unsigned int crc_type,
                                const unsigned int init_val,
                                const unsigned char *const crc_table)
        __attribute__((nonnull(1, 6)));
unsigned int compute_crc_dynamic(const unsigned char *const ip,
                                 const unsigned char *const ip2,
                                 const unsigned char *const next_header,
                                 const unsigned int crc_type,
                                 const unsigned int init_val,
                                 const unsigned char *const crc_table)
        __attribute__((nonnull(1, 6)));

unsigned int udp_compute_crc_static(const unsigned char *const ip,
                                    const unsigned char *const ip2,
                                    const unsigned char *const next_header,
                                    const unsigned int crc_type,
                                    const unsigned int init_val,
                                    const unsigned char *const crc_table)
        __attribute__((nonnull(1, 3, 6)));
unsigned int udp_compute_crc_dynamic(const unsigned char *const ip,
                                     const unsigned char *const ip2,
                                     const unsigned char *const next_header,
                                     const unsigned int crc_type,
                                     const unsigned int init_val,
                                     const unsigned char *const crc_table)
        __attribute__((nonnull(1, 3, 6)));

unsigned int rtp_compute_crc_static(const unsigned char *const ip,
                                    const unsigned char *const ip2,
                                    const unsigned char *const next_header,
                                    const unsigned int crc_type,
                                    const unsigned int init_val,
                                    const unsigned char *const crc_table)
        __attribute__((nonnull(1, 3, 6)));
unsigned int rtp_compute_crc_dynamic(const unsigned char *const ip,
                                     const unsigned char *const ip2,
                                     const unsigned char *const next_header,
                                     const unsigned int crc_type,
                                     const unsigned int init_val,
                                     const unsigned char *const crc_table)
        __attribute__((nonnull(1, 3, 6)));

unsigned int ipv6_ext_compute_crc_static(const unsigned char *const ip,
                                         const unsigned int crc_type,
                                         const unsigned int init_val,
                                         const unsigned char *const crc_table)
        __attribute__((nonnull(1, 4)));
unsigned int ipv6_ext_compute_crc_dynamic(const unsigned char *const ip,
                                          const unsigned int crc_type,
                                          const unsigned int init_val,
                                          const unsigned char *const crc_table)
        __attribute__((nonnull(1, 4)));


#endif