open_esplibs: Add README and Copyright headers
This commit is contained in:
parent
678b59babf
commit
6c9d478336
12 changed files with 82 additions and 0 deletions
15
open_esplibs/README.md
Normal file
15
open_esplibs/README.md
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
# Open Espressif Libs
|
||||||
|
|
||||||
|
These are functional recreations of the MIT licensed binary Espressif SDK libraries found in `lib`. They keep the same functionality as the SDK libraries (possibly with bugfixes or other minor tweaks), but are compiled from source.
|
||||||
|
|
||||||
|
Most of the reverse engineering work so far has been by Alex Stewart (@foogod).
|
||||||
|
|
||||||
|
See http://esp8266-re.foogod.com/wiki/ for more technical details of SDK library internals.
|
||||||
|
|
||||||
|
# Disabling
|
||||||
|
|
||||||
|
The open ESP libs are compiled in by default, and they automatically replace any binary SDK symbols (functions, etc.) with the same names.
|
||||||
|
|
||||||
|
To compile using the binary SDK libraries only, override the COMPONENTS list in parameters.mk to remove the open_esplibs component, or add -DOPEN_ESPLIBS=0 to CPPFLAGS.
|
||||||
|
|
||||||
|
To selectively replace some functionality with binary SDK functionality for debugging, edit the header file open_esplibs/include/open_esplibs.h
|
|
@ -1,3 +1,11 @@
|
||||||
|
/* Internal function declarations for Espressif SDK libmain functions.
|
||||||
|
|
||||||
|
These are internal-facing declarations, it is not recommended to include these headers in your program.
|
||||||
|
(look at the headers in include/espressif/ instead and use these whenever possible.)
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE.
|
||||||
|
*/
|
||||||
#include "sdk_internal.h"
|
#include "sdk_internal.h"
|
||||||
#ifndef _ESPLIBS_LIBMAIN_H
|
#ifndef _ESPLIBS_LIBMAIN_H
|
||||||
#define _ESPLIBS_LIBMAIN_H
|
#define _ESPLIBS_LIBMAIN_H
|
||||||
|
|
|
@ -1,3 +1,11 @@
|
||||||
|
/* Internal function declarations for Espressif SDK libnet80211 functions.
|
||||||
|
|
||||||
|
These are internal-facing declarations, it is not recommended to include these headers in your program.
|
||||||
|
(look at the headers in include/espressif/ instead and use these whenever possible.)
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE.
|
||||||
|
*/
|
||||||
#ifndef _ESPLIBS_LIBNET80211_H
|
#ifndef _ESPLIBS_LIBNET80211_H
|
||||||
#define _ESPLIBS_LIBNET80211_H
|
#define _ESPLIBS_LIBNET80211_H
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,11 @@
|
||||||
|
/* Internal function declarations for Espressif SDK libphy functions.
|
||||||
|
|
||||||
|
These are internal-facing declarations, it is not recommended to include these headers in your program.
|
||||||
|
(look at the headers in include/espressif/ instead and use these whenever possible.)
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE.
|
||||||
|
*/
|
||||||
#ifndef _ESPLIBS_LIBPHY_H
|
#ifndef _ESPLIBS_LIBPHY_H
|
||||||
#define _ESPLIBS_LIBPHY_H
|
#define _ESPLIBS_LIBPHY_H
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,11 @@
|
||||||
|
/* Internal function declarations for Espressif SDK libpp functions.
|
||||||
|
|
||||||
|
These are internal-facing declarations, it is not recommended to include these headers in your program.
|
||||||
|
(look at the headers in include/espressif/ instead and use these whenever possible.)
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE.
|
||||||
|
*/
|
||||||
#ifndef _ESPLIBS_LIBPP_H
|
#ifndef _ESPLIBS_LIBPP_H
|
||||||
#define _ESPLIBS_LIBPP_H
|
#define _ESPLIBS_LIBPP_H
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
/* Recreated Espressif libmain misc.o contents.
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE
|
||||||
|
*/
|
||||||
#include "open_esplibs.h"
|
#include "open_esplibs.h"
|
||||||
#if OPEN_LIBMAIN_MISC
|
#if OPEN_LIBMAIN_MISC
|
||||||
// The contents of this file are only built if OPEN_LIBMAIN_MISC is set to true
|
// The contents of this file are only built if OPEN_LIBMAIN_MISC is set to true
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
/* Recreated Espressif libmain os_cpu_o contents.
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE
|
||||||
|
*/
|
||||||
#include "open_esplibs.h"
|
#include "open_esplibs.h"
|
||||||
#if OPEN_LIBMAIN_OS_CPU_A
|
#if OPEN_LIBMAIN_OS_CPU_A
|
||||||
// The contents of this file are only built if OPEN_LIBMAIN_OS_CPU_A is set to true
|
// The contents of this file are only built if OPEN_LIBMAIN_OS_CPU_A is set to true
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
/* Recreated Espressif libmain os_cpu_o contents.
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE
|
||||||
|
*/
|
||||||
#include "open_esplibs.h"
|
#include "open_esplibs.h"
|
||||||
#if OPEN_LIBMAIN_SPI_FLASH
|
#if OPEN_LIBMAIN_SPI_FLASH
|
||||||
// The contents of this file are only built if OPEN_LIBMAIN_SPI_FLASH is set to true
|
// The contents of this file are only built if OPEN_LIBMAIN_SPI_FLASH is set to true
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
/* Recreated Espressif libmain timers.o contents.
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE
|
||||||
|
*/
|
||||||
#include "open_esplibs.h"
|
#include "open_esplibs.h"
|
||||||
#if OPEN_LIBMAIN_TIMERS
|
#if OPEN_LIBMAIN_TIMERS
|
||||||
// The contents of this file are only built if OPEN_LIBMAIN_TIMERS is set to true
|
// The contents of this file are only built if OPEN_LIBMAIN_TIMERS is set to true
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
/* Recreated Espressif libmain uart.o contents.
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE
|
||||||
|
*/
|
||||||
#include "open_esplibs.h"
|
#include "open_esplibs.h"
|
||||||
#if OPEN_LIBMAIN_UART
|
#if OPEN_LIBMAIN_UART
|
||||||
// The contents of this file are only built if OPEN_LIBMAIN_UART is set to true
|
// The contents of this file are only built if OPEN_LIBMAIN_UART is set to true
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
/* Recreated Espressif libmain user_interface.o contents.
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE
|
||||||
|
*/
|
||||||
#include "open_esplibs.h"
|
#include "open_esplibs.h"
|
||||||
#if OPEN_LIBMAIN_USER_INTERFACE
|
#if OPEN_LIBMAIN_USER_INTERFACE
|
||||||
// The contents of this file are only built if OPEN_LIBMAIN_USER_INTERFACE is set to true
|
// The contents of this file are only built if OPEN_LIBMAIN_USER_INTERFACE is set to true
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
/* Recreated Espressif libmain xtensa_context.o contents.
|
||||||
|
|
||||||
|
Copyright (C) 2015 Espressif Systems. Derived from MIT Licensed SDK libraries.
|
||||||
|
BSD Licensed as described in the file LICENSE
|
||||||
|
*/
|
||||||
#include "open_esplibs.h"
|
#include "open_esplibs.h"
|
||||||
#if OPEN_LIBMAIN_XTENSA_CONTEXT
|
#if OPEN_LIBMAIN_XTENSA_CONTEXT
|
||||||
// The contents of this file are only built if OPEN_LIBMAIN_XTENSA_CONTEXT is set to true
|
// The contents of this file are only built if OPEN_LIBMAIN_XTENSA_CONTEXT is set to true
|
||||||
|
|
Loading…
Reference in a new issue