neorv32_crc.h

Go to the documentation of this file.

// ================================================================================ //
// The NEORV32 RISC-V Processor - https://github.com/stnolting/neorv32              //
// Copyright (c) NEORV32 contributors.                                              //
// Copyright (c) 2020 - 2025 Stephan Nolting. All rights reserved.                  //
// Licensed under the BSD-3-Clause license, see LICENSE for details.                //
// SPDX-License-Identifier: BSD-3-Clause                                            //
// ================================================================================ //

 
#ifndef NEORV32_CRC_H
#define NEORV32_CRC_H
 
#include <stdint.h>
 
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t MODE; 
  uint32_t POLY; 
  uint32_t DATA; 
  uint32_t SREG; 
} neorv32_crc_t;

#define NEORV32_CRC ((neorv32_crc_t*) (NEORV32_CRC_BASE))

enum NEORV32_CRC_MODE_enum {
  CRC_MODE8  = 0b00, 
  CRC_MODE16 = 0b01, 
  CRC_MODE32 = 0b10, 
};

 
 
/**********************************************************************/
int      neorv32_crc_available(void);
void     neorv32_crc_setup(uint32_t mode, uint32_t poly, uint32_t start);
uint32_t neorv32_crc_block(uint8_t *byte, int length);
void     neorv32_crc_single(uint8_t byte);
uint32_t neorv32_crc_get(void);
 
 
#endif // NEORV32_CRC_H