Files
libmetal/lib/system/linux/sys.h
Arnaud Pouliquen d3a27c1454 lib: fix file headers for doxygen generation
- start by "/**",
- fix file relative path,
- fix typos,

Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
2026-01-13 10:33:04 +01:00

137 lines
3.0 KiB
C

/*
* Copyright (c) 2015, Xilinx Inc. and Contributors. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file linux/sys.h
* @brief Linux system primitives for libmetal.
*/
#ifndef __METAL_SYS__H__
#error "Include metal/sys.h instead of metal/linux/sys.h"
#endif
#ifndef __METAL_LINUX_SYS__H__
#define __METAL_LINUX_SYS__H__
#include <fcntl.h>
#include <libgen.h>
#include <limits.h>
#include <metal/cpu.h>
#include <metal/errno.h>
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <syslog.h>
#include <sys/file.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <sys/syscall.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <unistd.h>
#include <linux/futex.h>
#include <sysfs/libsysfs.h>
#ifdef HAVE_HUGETLBFS_H
#include <hugetlbfs.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
#define METAL_INVALID_VADDR NULL
#define MAX_PAGE_SIZES 32
#define metal_yield() metal_cpu_yield()
struct metal_device;
/** Structure of shared page or hugepage sized data. */
struct metal_page_size {
/** Page size. */
size_t page_size;
/** Page shift. */
unsigned long page_shift;
/** Path to hugetlbfs (or tmpfs) mount point. */
char path[PATH_MAX];
/** Flags to use for mmap. */
int mmap_flags;
};
/** Structure of linux specific libmetal runtime state. */
struct metal_state {
/** Common (system independent) data. */
struct metal_common_state common;
/** file descriptor for shared data. */
int data_fd;
/** system page size. */
unsigned long page_size;
/** system page shift. */
unsigned long page_shift;
/** sysfs mount point. */
const char *tmp_path;
/** available page sizes. */
struct metal_page_size page_sizes[MAX_PAGE_SIZES];
/** number of available page sizes. */
int num_page_sizes;
/** File descriptor for /proc/self/pagemap (or -1). */
int pagemap_fd;
};
#ifdef METAL_INTERNAL
int metal_linux_bus_init(void);
void metal_linux_bus_finish(void);
int metal_open(const char *path, int shm);
int metal_map(int fd, off_t offset, size_t size, int expand,
int flags, void **result);
int metal_unmap(void *mem, size_t size);
/**
* @brief Read a device tree property of a device
*
* @param[in] device metal_device of the intended DT node
* @param[in] property_name name of the property to be read
* @param[out] output output buffer to store read data
* @param[in] len number of bytes to be read
* @return 0 on success, or -errno on error.
*/
int metal_linux_get_device_property(struct metal_device *device,
const char *property_name,
void *output, int len);
#define metal_for_each_page_size_up(ps) \
for ((ps) = &_metal.page_sizes[0]; \
(ps) <= &_metal.page_sizes[_metal.num_page_sizes - 1]; \
(ps)++)
#define metal_for_each_page_size_down(ps) \
for ((ps) = &_metal.page_sizes[_metal.num_page_sizes - 1]; \
(ps) >= &_metal.page_sizes[0]; \
(ps)--)
#endif
#ifdef __cplusplus
}
#endif
#endif /* __METAL_LINUX_SYS__H__ */