Spdk/include/spdk/mmio.h
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

112 lines
1.9 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) Intel Corporation.
* All rights reserved.
*/
/** \file
* Memory-mapped I/O utility functions
*/
#ifndef SPDK_MMIO_H
#define SPDK_MMIO_H
#include "spdk/stdinc.h"
#ifdef __cplusplus
extern "C" {
#endif
#include "spdk/barrier.h"
#ifdef __x86_64__
#define SPDK_MMIO_64BIT 1 /* Can do atomic 64-bit memory read/write (over PCIe) */
#else
#define SPDK_MMIO_64BIT 0
#endif
static inline uint8_t
spdk_mmio_read_1(const volatile uint8_t *addr)
{
spdk_compiler_barrier();
return *addr;
}
static inline void
spdk_mmio_write_1(volatile uint8_t *addr, uint8_t val)
{
spdk_compiler_barrier();
*addr = val;
}
static inline uint16_t
spdk_mmio_read_2(const volatile uint16_t *addr)
{
spdk_compiler_barrier();
return *addr;
}
static inline void
spdk_mmio_write_2(volatile uint16_t *addr, uint16_t val)
{
spdk_compiler_barrier();
*addr = val;
}
static inline uint32_t
spdk_mmio_read_4(const volatile uint32_t *addr)
{
spdk_compiler_barrier();
return *addr;
}
static inline void
spdk_mmio_write_4(volatile uint32_t *addr, uint32_t val)
{
spdk_compiler_barrier();
*addr = val;
}
static inline uint64_t
spdk_mmio_read_8(volatile uint64_t *addr)
{
uint64_t val;
volatile uint32_t *addr32 = (volatile uint32_t *)addr;
spdk_compiler_barrier();
if (SPDK_MMIO_64BIT) {
val = *addr;
} else {
/*
* Read lower 4 bytes before upper 4 bytes.
* This particular order is required by I/OAT.
* If the other order is required, use a pair of spdk_mmio_read_4() calls.
*/
val = addr32[0];
val |= (uint64_t)addr32[1] << 32;
}
return val;
}
static inline void
spdk_mmio_write_8(volatile uint64_t *addr, uint64_t val)
{
volatile uint32_t *addr32 = (volatile uint32_t *)addr;
spdk_compiler_barrier();
if (SPDK_MMIO_64BIT) {
*addr = val;
} else {
addr32[0] = (uint32_t)val;
addr32[1] = (uint32_t)(val >> 32);
}
}
#ifdef __cplusplus
}
#endif
#endif