ground/gcs/src/libs/utils/crc.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       crc.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2013.
   6  *             Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
   7  * @addtogroup GCSPlugins GCS Plugins
   8  * @{
   9  * @addtogroup CorePlugin Core Plugin
  10  * @{
  11  * @brief The Core GCS plugin
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #ifndef CRC_H
  30 #define CRC_H
  31
  32 #include "utils_global.h"
  33
  34 namespace Utils {
  35 class QTCREATOR_UTILS_EXPORT Crc {
  36 public:
  37     /**
  38      * Update the crc value with new data.
  39      *
  40      * \param crc      The current crc value.
  41      * \param data     data to update the crc with.
  42      * \return         The updated crc value.
  43      */
  44     static quint8 updateCRC(quint8 crc, const quint8 data);
  45
  46     /**
  47      * Update the crc value with new data.
  48      *
  49      * \param crc      The current crc value.
  50      * \param data     Pointer to a buffer of \a data_len bytes.
  51      * \param length   Number of bytes in the \a data buffer.
  52      * \return         The updated crc value.
  53      */
  54     static quint8 updateCRC(quint8 crc, const quint8 *data, qint32 length);
  55 };
  56 } // namespace Utils
  57
  58 #endif // CRC_H