infoblock.h

/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_INFOBLOCK_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_INFOBLOCK_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if !defined(TRUE) || !defined(FALSE)
#define TRUE 1
#define FALSE 0
#endif
#define INFOBLOCK_LINE_SIZE 8
 
#define INFOBLOCK_LINE_OVERHEAD 2
 
#define INFOBLOCK_ICE_LOCK_SIZE 8
 
#define INFOBLOCK_WRITE_LOCK_LINE_SIZE 16
 
#define ICELOCK_UNMODIFIED_VALUE 0xFFFF
 
#define ICELOCK_EVEN_LOCK_VALUE 0xA5A5
 
#define ICELOCK_ODD_LOCK_VALUE 0x5A5A
 
#define INFOBLOCK_MAXIMUM_READ_LENGTH 64
 
#define INFOBLOCK_USN_OFFSET 0x00
 
#define INFOBLOCK_ICE_LOCK_OFFSET 0x30
 
#define INFOBLOCK_ICE_LOCK_MINIMUM 1
 
#define INFOBLOCK_KEY_OFFSET 0x1000
#define INFOBLOCK_KEY_SIZE 64
 
#define INFOBLOCK_ENABLE_SIZE (8)
 
#define INFOBLOCK_ENABLE_PATTERN 0x5A5AA5A5
 
typedef enum {
    INFOBLOCK_LINE_FORMAT_USN, 
    INFOBLOCK_LINE_FORMAT_RAW, 
    INFOBLOCK_LINE_FORMAT_DESIGN, 
} lineformat_e;
 
uint16_t crc15_highbitinput(uint16_t crc15val, uint8_t *input, int bitlength);
 
int infoblock_readraw(uint32_t offset, uint8_t *data);
 
int infoblock_read(uint32_t offset, uint8_t *data, int length);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_INFOBLOCK_H_