diff options
Diffstat (limited to 'src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-key.h')
-rw-r--r-- | src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-key.h | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-key.h b/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-key.h new file mode 100644 index 0000000000..c16bfd7559 --- /dev/null +++ b/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-key.h @@ -0,0 +1,86 @@ +/***********************license start*********************************** +* Copyright (c) 2003-2017 Cavium Inc. (support@cavium.com). All rights +* reserved. +* +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions are +* met: +* +* * Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* +* * Redistributions in binary form must reproduce the above +* copyright notice, this list of conditions and the following +* disclaimer in the documentation and/or other materials provided +* with the distribution. +* +* * Neither the name of Cavium Inc. nor the names of +* its contributors may be used to endorse or promote products +* derived from this software without specific prior written +* permission. +* +* This Software, including technical data, may be subject to U.S. export +* control laws, including the U.S. Export Administration Act and its +* associated regulations, and may be subject to export or import +* regulations in other countries. +* +* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" +* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR +* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT +* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY +* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT +* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES +* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR +* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, +* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK +* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. +***********************license end**************************************/ + +/** + * @file + * + * Interface to the on chip key memory. Key memory is + * 8k on chip that is inaccessible from off chip. It can + * also be cleared using an external hardware pin. + * + * <hr>$Revision: 49448 $<hr> + * + * @addtogroup hal + * @{ + */ + +#define BDK_KEY_MEM_SIZE 8192 /* Size in bytes */ + +/** + * Read from KEY memory + * + * @param node Which node to use + * @param address Address (byte) in key memory to read + * 0 <= address < BDK_KEY_MEM_SIZE + * @return Value from key memory + */ +extern uint64_t bdk_key_read(bdk_node_t node, uint64_t address); + +/** + * Write to KEY memory + * + * @param node Which node to use + * @param address Address (byte) in key memory to write + * 0 <= address < BDK_KEY_MEM_SIZE + * @param value Value to write to key memory + */ +extern void bdk_key_write(bdk_node_t node, uint64_t address, uint64_t value); + +/** + * Allocate an area in key memory for storing data. Return a pointer to the + * memory on success. + * + * @param node Node to allocate on + * @param size_bytes Number of bytes to allocate + * + * @return Pointer to key memory, or NULL on failure + */ +extern void* bdk_key_alloc(bdk_node_t node, int size_bytes); + +/** @} */ |