mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
ab784bb53a
Add files required for DPP feature from upstream. These file expose the functionality to create DPP packets. Ported crypto layer from openssl to mbedtls. Interfacing to use these API will be added in seperate commit
307 lines
8.7 KiB
C
307 lines
8.7 KiB
C
/*
|
|
* OS specific functions
|
|
* Copyright (c) 2005-2009, Jouni Malinen <j@w1.fi>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License version 2 as
|
|
* published by the Free Software Foundation.
|
|
*
|
|
* Alternatively, this software may be distributed under the terms of BSD
|
|
* license.
|
|
*
|
|
* See README and COPYING for more details.
|
|
*/
|
|
|
|
#ifndef OS_H
|
|
#define OS_H
|
|
#include "esp_types.h"
|
|
#include <string.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include "esp_err.h"
|
|
// #include "esp32/rom/ets_sys.h"
|
|
|
|
typedef time_t os_time_t;
|
|
|
|
/**
|
|
* os_sleep - Sleep (sec, usec)
|
|
* @sec: Number of seconds to sleep
|
|
* @usec: Number of microseconds to sleep
|
|
*/
|
|
void os_sleep(os_time_t sec, os_time_t usec);
|
|
|
|
struct os_time {
|
|
os_time_t sec;
|
|
suseconds_t usec;
|
|
};
|
|
|
|
struct os_tm {
|
|
int sec; /* 0..59 or 60 for leap seconds */
|
|
int min; /* 0..59 */
|
|
int hour; /* 0..23 */
|
|
int day; /* 1..31 */
|
|
int month; /* 1..12 */
|
|
int year; /* Four digit year */
|
|
};
|
|
|
|
/**
|
|
* os_get_time - Get current time (sec, usec)
|
|
* @t: Pointer to buffer for the time
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int os_get_time(struct os_time *t);
|
|
|
|
|
|
/* Helper macros for handling struct os_time */
|
|
|
|
#define os_time_before(a, b) \
|
|
((a)->sec < (b)->sec || \
|
|
((a)->sec == (b)->sec && (a)->usec < (b)->usec))
|
|
|
|
#define os_time_sub(a, b, res) do { \
|
|
(res)->sec = (a)->sec - (b)->sec; \
|
|
(res)->usec = (a)->usec - (b)->usec; \
|
|
if ((res)->usec < 0) { \
|
|
(res)->sec--; \
|
|
(res)->usec += 1000000; \
|
|
} \
|
|
} while (0)
|
|
|
|
/**
|
|
* os_mktime - Convert broken-down time into seconds since 1970-01-01
|
|
* @year: Four digit year
|
|
* @month: Month (1 .. 12)
|
|
* @day: Day of month (1 .. 31)
|
|
* @hour: Hour (0 .. 23)
|
|
* @min: Minute (0 .. 59)
|
|
* @sec: Second (0 .. 60)
|
|
* @t: Buffer for returning calendar time representation (seconds since
|
|
* 1970-01-01 00:00:00)
|
|
* Returns: 0 on success, -1 on failure
|
|
*
|
|
* Note: The result is in seconds from Epoch, i.e., in UTC, not in local time
|
|
* which is used by POSIX mktime().
|
|
*/
|
|
int os_mktime(int year, int month, int day, int hour, int min, int sec,
|
|
os_time_t *t);
|
|
|
|
int os_gmtime(os_time_t t, struct os_tm *tm);
|
|
|
|
/**
|
|
* os_daemonize - Run in the background (detach from the controlling terminal)
|
|
* @pid_file: File name to write the process ID to or %NULL to skip this
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int os_daemonize(const char *pid_file);
|
|
|
|
/**
|
|
* os_daemonize_terminate - Stop running in the background (remove pid file)
|
|
* @pid_file: File name to write the process ID to or %NULL to skip this
|
|
*/
|
|
void os_daemonize_terminate(const char *pid_file);
|
|
|
|
/**
|
|
* os_get_random - Get cryptographically strong pseudo random data
|
|
* @buf: Buffer for pseudo random data
|
|
* @len: Length of the buffer
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int os_get_random(unsigned char *buf, size_t len);
|
|
|
|
/**
|
|
* os_random - Get pseudo random value (not necessarily very strong)
|
|
* Returns: Pseudo random value
|
|
*/
|
|
unsigned long os_random(void);
|
|
|
|
/**
|
|
* os_rel2abs_path - Get an absolute path for a file
|
|
* @rel_path: Relative path to a file
|
|
* Returns: Absolute path for the file or %NULL on failure
|
|
*
|
|
* This function tries to convert a relative path of a file to an absolute path
|
|
* in order for the file to be found even if current working directory has
|
|
* changed. The returned value is allocated and caller is responsible for
|
|
* freeing it. It is acceptable to just return the same path in an allocated
|
|
* buffer, e.g., return strdup(rel_path). This function is only used to find
|
|
* configuration files when os_daemonize() may have changed the current working
|
|
* directory and relative path would be pointing to a different location.
|
|
*/
|
|
char * os_rel2abs_path(const char *rel_path);
|
|
|
|
/**
|
|
* os_program_init - Program initialization (called at start)
|
|
* Returns: 0 on success, -1 on failure
|
|
*
|
|
* This function is called when a programs starts. If there are any OS specific
|
|
* processing that is needed, it can be placed here. It is also acceptable to
|
|
* just return 0 if not special processing is needed.
|
|
*/
|
|
int os_program_init(void);
|
|
|
|
/**
|
|
* os_program_deinit - Program deinitialization (called just before exit)
|
|
*
|
|
* This function is called just before a program exists. If there are any OS
|
|
* specific processing, e.g., freeing resourced allocated in os_program_init(),
|
|
* it should be done here. It is also acceptable for this function to do
|
|
* nothing.
|
|
*/
|
|
void os_program_deinit(void);
|
|
|
|
/**
|
|
* os_setenv - Set environment variable
|
|
* @name: Name of the variable
|
|
* @value: Value to set to the variable
|
|
* @overwrite: Whether existing variable should be overwritten
|
|
* Returns: 0 on success, -1 on error
|
|
*
|
|
* This function is only used for wpa_cli action scripts. OS wrapper does not
|
|
* need to implement this if such functionality is not needed.
|
|
*/
|
|
int os_setenv(const char *name, const char *value, int overwrite);
|
|
|
|
/**
|
|
* os_unsetenv - Delete environent variable
|
|
* @name: Name of the variable
|
|
* Returns: 0 on success, -1 on error
|
|
*
|
|
* This function is only used for wpa_cli action scripts. OS wrapper does not
|
|
* need to implement this if such functionality is not needed.
|
|
*/
|
|
int os_unsetenv(const char *name);
|
|
|
|
/**
|
|
* os_readfile - Read a file to an allocated memory buffer
|
|
* @name: Name of the file to read
|
|
* @len: For returning the length of the allocated buffer
|
|
* Returns: Pointer to the allocated buffer or %NULL on failure
|
|
*
|
|
* This function allocates memory and reads the given file to this buffer. Both
|
|
* binary and text files can be read with this function. The caller is
|
|
* responsible for freeing the returned buffer with os_free().
|
|
*/
|
|
char * os_readfile(const char *name, size_t *len);
|
|
|
|
/*
|
|
* The following functions are wrapper for standard ANSI C or POSIX functions.
|
|
* By default, they are just defined to use the standard function name and no
|
|
* os_*.c implementation is needed for them. This avoids extra function calls
|
|
* by allowing the C pre-processor take care of the function name mapping.
|
|
*
|
|
* If the target system uses a C library that does not provide these functions,
|
|
* build_config.h can be used to define the wrappers to use a different
|
|
* function name. This can be done on function-by-function basis since the
|
|
* defines here are only used if build_config.h does not define the os_* name.
|
|
* If needed, os_*.c file can be used to implement the functions that are not
|
|
* included in the C library on the target system. Alternatively,
|
|
* OS_NO_C_LIB_DEFINES can be defined to skip all defines here in which case
|
|
* these functions need to be implemented in os_*.c file for the target system.
|
|
*/
|
|
|
|
#ifndef os_malloc
|
|
#define os_malloc(s) malloc((s))
|
|
#endif
|
|
#ifndef os_realloc
|
|
#define os_realloc(p, s) realloc((p), (s))
|
|
#endif
|
|
#ifndef os_zalloc
|
|
#define os_zalloc(s) calloc(1, (s))
|
|
#endif
|
|
#ifndef os_free
|
|
#define os_free(p) free((p))
|
|
#endif
|
|
|
|
#ifndef os_bzero
|
|
#define os_bzero(s, n) bzero(s, n)
|
|
#endif
|
|
|
|
|
|
#ifndef os_strdup
|
|
#ifdef _MSC_VER
|
|
#define os_strdup(s) _strdup(s)
|
|
#else
|
|
#define os_strdup(s) strdup(s)
|
|
#endif
|
|
#endif
|
|
char * ets_strdup(const char *s);
|
|
|
|
#ifndef os_memcpy
|
|
#define os_memcpy(d, s, n) memcpy((d), (s), (n))
|
|
#endif
|
|
#ifndef os_memmove
|
|
#define os_memmove(d, s, n) memmove((d), (s), (n))
|
|
#endif
|
|
#ifndef os_memset
|
|
#define os_memset(s, c, n) memset(s, c, n)
|
|
#endif
|
|
#ifndef os_memcmp
|
|
#define os_memcmp(s1, s2, n) memcmp((s1), (s2), (n))
|
|
#endif
|
|
#ifndef os_memcmp_const
|
|
#define os_memcmp_const(s1, s2, n) memcmp((s1), (s2), (n))
|
|
#endif
|
|
|
|
|
|
#ifndef os_strlen
|
|
#define os_strlen(s) strlen(s)
|
|
#endif
|
|
#ifndef os_strcasecmp
|
|
#ifdef _MSC_VER
|
|
#define os_strcasecmp(s1, s2) _stricmp((s1), (s2))
|
|
#else
|
|
#define os_strcasecmp(s1, s2) strcasecmp((s1), (s2))
|
|
#endif
|
|
#endif
|
|
#ifndef os_strncasecmp
|
|
#ifdef _MSC_VER
|
|
#define os_strncasecmp(s1, s2, n) _strnicmp((s1), (s2), (n))
|
|
#else
|
|
#define os_strncasecmp(s1, s2, n) strncasecmp((s1), (s2), (n))
|
|
#endif
|
|
#endif
|
|
#ifndef os_strchr
|
|
#define os_strchr(s, c) strchr((s), (c))
|
|
#endif
|
|
#ifndef os_strcmp
|
|
#define os_strcmp(s1, s2) strcmp((s1), (s2))
|
|
#endif
|
|
#ifndef os_strncmp
|
|
#define os_strncmp(s1, s2, n) strncmp((s1), (s2), (n))
|
|
#endif
|
|
#ifndef os_strncpy
|
|
#define os_strncpy(d, s, n) strncpy((d), (s), (n))
|
|
#endif
|
|
#ifndef os_strrchr
|
|
#define os_strrchr(s, c) strrchr((s), (c))
|
|
#endif
|
|
#ifndef os_strstr
|
|
#define os_strstr(h, n) strstr((h), (n))
|
|
#endif
|
|
|
|
#ifndef os_snprintf
|
|
#ifdef _MSC_VER
|
|
#define os_snprintf _snprintf
|
|
#else
|
|
#define os_snprintf snprintf
|
|
#endif
|
|
#endif
|
|
|
|
static inline int os_snprintf_error(size_t size, int res)
|
|
{
|
|
return res < 0 || (unsigned int) res >= size;
|
|
}
|
|
|
|
/**
|
|
* os_strlcpy - Copy a string with size bound and NUL-termination
|
|
* @dest: Destination
|
|
* @src: Source
|
|
* @siz: Size of the target buffer
|
|
* Returns: Total length of the target string (length of src) (not including
|
|
* NUL-termination)
|
|
*
|
|
* This function matches in behavior with the strlcpy(3) function in OpenBSD.
|
|
*/
|
|
size_t os_strlcpy(char *dest, const char *src, size_t siz);
|
|
#endif /* OS_H */
|