mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-07-04 20:08:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
6,777 Commits 4 Branches 50 Tags 14 MiB
7807f706f3
Commit Graph

255 Commits

Author SHA1 Message Date
Dirk Ziegelmeier
84b2a0f55b Remove raw API TCP/UDP function documentation from rawapi.txt - it is now integrated in doxygen docs. 
This avoid having a second description for the same stuff that is "bit-rotting" because noone remembers to update this file.
Also remove outdated and misleading zero-copy TX information.
 2017-10-17 21:59:34 +02:00
Dirk Ziegelmeier
558bd73a6d Fix comment indent in main_page.h 2017-10-16 23:27:00 +02:00
Dirk Ziegelmeier
001e1f1127 Improve lwIP doxygen documentation by copying several passages from rawapi.txt to the corresponding doxygen places 2017-10-16 23:24:52 +02:00
Dirk Ziegelmeier
921f601b5d Improve lwIP doxygen documentation by copying several passages from rawapi.txt to the corresponding function documentation 2017-10-16 23:14:28 +02:00
Dirk Ziegelmeier
653a1e7778 Fix bug #52113: recv callback: To free or not to free pbuf when returning ERR_ABRT? 
Change the text according to Ambroz' suggestion
 2017-10-16 10:01:45 +02:00
Our Air Quality
f934ca7a03 [PATCH] Deprecate sys_arch_sem_wait and sys_arch_mbox_fetch returning the time waited 
These are now defined to return != SYS_ARCH_TIMEOUT on success rather than the time
waiting. The returned times were unused by lwip and this simplifies at
least some implementations.

Signed-off-by: goldsimon <goldsimon@gmx.de>
 2017-07-20 22:04:34 +02:00
Our Air Quality
66a84cb2ef Clarify that sys_arch_protect() always has a matching unprotect. 
This is to allow an implementation to use a nesting counter, or a
recursive mutex. Also clarify that the value returned by
sys_arch_protect() is opaque to lwip and implementation dependent.

Signed-off-by: goldsimon <goldsimon@gmx.de>
 2017-07-20 21:22:35 +02:00
goldsimon
8db0001e32 Adjust pbuf reuse documentation a bit: pbufs should never be reused after transmit 2017-05-18 09:19:08 +02:00
Adrey Vinogradov
46f2e25ce0 Fixed bug #51002 
Signed-off-by: goldsimon <goldsimon@gmx.de>
 2017-05-11 20:51:41 +02:00
Dirk Ziegelmeier
a09a8e4a06 Some documentation updates and fixes 
Dedicated Zero-copy RX page
Fix doxygen warnings
 2017-04-27 12:41:08 +02:00
Dirk Ziegelmeier
3266511ebb Improve documentation, add TLS stuff 2017-03-28 21:25:49 +02:00
Dirk Ziegelmeier
ab736a4764 Add altcp to doxygen docs 2017-03-22 23:32:32 +01:00
Dirk Ziegelmeier
59fba75cd8 Update doxygen version to 2.0.3 as in init.h 2017-03-17 09:55:04 +01:00
Dirk Ziegelmeier
b9a40a5163 Fix coding style NO_SYS example code 2017-03-15 20:16:52 +01:00
Dirk Ziegelmeier
da0714d7cb Fix starting DHCP in NO_SYS example code 2017-03-15 20:09:39 +01:00
Dirk Ziegelmeier
d9b279d150 Cleanup documentation a bit: rename "Addons" to "NETIFs" - its a more appropriate name 2017-03-15 20:03:55 +01:00
goldsimon
15918d8971 mdns.txt: changed the LWIP_MDNS_STRNCASECMP text again to reflect the fact that there are 2 names for 1 function... 2017-03-11 20:35:58 +01:00
goldsimon
681951c175 mdns.txt: LWIP_MDNS_STRNCASECMP -> lwip_strnicmp 2017-03-10 23:03:45 +01:00
Dirk Ziegelmeier
e4b356f08c Add netif extended callback to doxygen docs 2017-02-26 09:56:16 +01:00
Dirk Ziegelmeier
a826b1aeeb Add IPv6 scopes to documentation 2017-02-09 13:21:19 +01:00
goldsimon
48d2243845 Clarify/add LWIP_PROVIDE_ERRNO comments 2017-01-31 12:38:53 +01:00
Dirk Ziegelmeier
ee3154999a Add CHANGELOG to lwIP HTML documentation 2017-01-24 11:45:51 +01:00
Dirk Ziegelmeier
861dab5b22 Set lwIP version to 2.0.2 in doxygen script 2017-01-15 09:22:33 +01:00
Axel Lin
7b40d1eb6f doc: mqtt_client: Update example code after adding port parameter to mqtt_client_connect() 
Signed-off-by: Axel Lin <axel.lin@ingics.com>
 2016-12-24 15:10:56 +01:00
Dirk Ziegelmeier
6e219b6b11 Change signature of mqtt_client_connect() to take an IP addr instead of a string 2016-12-21 09:36:28 +01:00
Dirk Ziegelmeier
ec1450bac4 Add mqtt documentation from Erik Anderson, rev 4b84fff 2016-12-21 09:29:47 +01:00
Dirk Ziegelmeier
a2ad9d36ca Improve documentation: Refer to compiler/platform abstraction in NO_SYS mode description 2016-12-08 15:25:38 +01:00
Dirk Ziegelmeier
33bdf9fa76 Doxygen: Fix project description text 2016-12-08 13:38:17 +01:00
Dirk Ziegelmeier
55fd567a84 Adapt doxygen docs version number 2016-12-08 13:37:01 +01:00
Joel Cunningham
7d0aeaf539 Doc: correct minor mis-spelling in sys_arch.txt 
This corrects a minor mis-spelling where "by" was mis-spelled as "ny"
 2016-11-30 10:28:38 -06:00
Richard Sailer
2ed755764e doxygen/generate.sh: Add shebang line 
This file had the x bit set.
But executing it produced an error, since it was
missing the "#!/bin/sh" line.

This patch adds the "#!/bin/sh" line and makes generate.sh directly executable.
 2016-11-25 09:12:40 +01:00
Axel Lin
e040132d92 PPP, documentation: Fix example code 
Fix the example code in status_cb() because dns_getserver() returns
const ip_addr_t *.

Signed-off-by: Axel Lin <axel.lin@ingics.com>
 2016-10-23 10:00:54 +02:00
Dirk Ziegelmeier
5477aa5a42 Minor: Documentation update 2016-10-09 09:41:26 +02:00
Dirk Ziegelmeier
13fb616bb2 Cleanup hton*/ntoh* function handling and platform abstraction 
Let lwip use functions/macros prefixed by lwip_ internally to avoid naming clashes with external #includes.
Remove over-complicated #define handling in def.h
Make functions easier to override in cc.h. The following is sufficient now (no more LWIP_PLATFORM_BYTESWAP):
#define lwip_htons(x) <your_htons>
#define lwip_htonl(x) <your_htonl>
 2016-10-06 12:55:57 +02:00
Dirk Ziegelmeier
d7f8d33506 Minor: update NO_SYS_SampleCode.c for IPv6 2016-09-30 09:35:27 +02:00
Dirk Ziegelmeier
db9c866fff Minor: Documentation update 2016-09-30 09:05:33 +02:00
Dirk Ziegelmeier
682b82aad8 Improve documentation: Some words about multiple execution contexts in lwIP 2016-09-29 12:51:45 +02:00
Dirk Ziegelmeier
5d811d799c Minor: Documentation updates 2016-09-27 21:18:03 +02:00
Dirk Ziegelmeier
9078f31544 Minor: memcpy -> MEMCPY / SMEMCPY 2016-08-30 21:56:09 +02:00
Dirk Ziegelmeier
0d510dd66d Add API macros for netif client data handling and update documentation accordingly 2016-08-26 11:21:49 +02:00
Dirk Ziegelmeier
537bd836c9 Minor: More documentation updates 2016-08-25 22:23:11 +02:00
Dirk Ziegelmeier
d9eaf6f310 docs: Remove link to example ports again, this should rather go to lwIP wiki... 2016-08-23 09:34:44 +02:00
Dirk Ziegelmeier
21c99b6ebb Add documentation page about example lwIP ports. Start with FreeRTOS from Pavel Pisa. 2016-08-20 09:23:29 +02:00
Dirk Ziegelmeier
7c0d952379 Add explicit documentation page about reporting bugs 2016-08-18 21:09:34 +02:00
Dirk Ziegelmeier
0c7a59b5db Minor: Documentation fixes 2016-08-18 11:06:50 +02:00
Dirk Ziegelmeier
c9ad58308a Minor documentation fixes 2016-08-18 10:59:18 +02:00
Dirk Ziegelmeier
af48bec63c Update MDNS docs after porting to dual-stack API 2016-08-14 17:12:01 +02:00
Dirk Ziegelmeier
a2894ede1c MDNS: make a few arguments const where suitable 2016-08-14 15:31:49 +02:00
Dirk Ziegelmeier
306113c8c3 Add MDNS to doxygen docs 2016-08-14 15:22:05 +02:00
Erik Ekman
4919932c49 Apply patch #8755: Multicast DNS responder support from Erik Ekman 2016-08-14 15:07:45 +02:00
Dirk Ziegelmeier
13251526fa Strip path prefix in doxygen docs - no /home/dziegel/ in the future :-) 2016-08-11 21:25:28 +02:00
Dirk Ziegelmeier
6ba03d543f Activate TCP backlog in documentation 2016-08-09 08:18:42 +02:00
Dirk Ziegelmeier
10332773ff Remove tcp_accepted() from rawapi.txt. Thanks to Sergio Caprile for pointing this out! 2016-08-08 16:09:26 +02:00
Dirk Ziegelmeier
fa568f7750 Fix typos in docs 2016-08-08 12:16:17 +02:00
Dirk Ziegelmeier
898e69118a Minor: documentation fix 2016-08-07 20:21:27 +02:00
Dirk Ziegelmeier
f55c0e7864 Move rawapi.txt description to main page - this doc really should be found and read by users 2016-08-07 20:21:27 +02:00
Dirk Ziegelmeier
8d07629b71 Some documentation cleanups and include more comments that have been already in code into doxygen docs 2016-08-07 10:05:34 +02:00
Dirk Ziegelmeier
2acfa0ebe7 Update NO_SYS_SampleCode.c: Don't access heap in IRQ 2016-08-06 20:28:01 +02:00
Dirk Ziegelmeier
a20cdc597a Fix comment in sample code 2016-08-05 09:55:48 +02:00
Dirk Ziegelmeier
70ee63ef3d Documentation: Add example code for NO_SYS use case 2016-08-05 09:53:50 +02:00
sg
6383ef88b4 had a look through the docs... 2016-08-03 20:40:52 +02:00
sg
dd110309e5 update some FILES list files 2016-08-03 20:21:54 +02:00
Dirk Ziegelmeier
4c06a737a4 Add redirection page for HTML doxygen output so one does not have to search for index.html in the huge output/html directory 2016-08-03 12:34:17 +02:00
Dirk Ziegelmeier
e4d75a75ea Remove accidentally committed file 2016-07-31 20:01:33 +02:00
Dirk Ziegelmeier
e76b8b2551 Document SNMP MIB2 netif stats counters 2016-07-31 16:02:22 +02:00
Dirk Ziegelmeier
6cc7f38c99 Fix typo in lwip.Doxyfile 2016-07-30 11:08:05 +02:00
Dirk Ziegelmeier
90fba8773f Revert "Fix my messing of opt.h and the other options files - it was actually caused by a cyclic #include which I did not see" 
It still does not work, due to #undef of options in opt.h, the documentation of many files is incomplete
This reverts commit 3f0dae29e9.
 2016-07-28 23:34:16 +02:00
Dirk Ziegelmeier
3f0dae29e9 Fix my messing of opt.h and the other options files - it was actually caused by a cyclic #include which I did not see 
Read the comments inside opt.h if you are interested.
 2016-07-28 18:59:36 +02:00
Dirk Ziegelmeier
8c620d9206 Restructure IPv6 config options 
Add generate.bat to generate docs quickly under Windows OS
 2016-07-28 09:21:16 +02:00
Dirk Ziegelmeier
b0284a6927 Move definition of options group from main_page.h to opt.h - it's more consistent like that 2016-07-28 08:27:49 +02:00
Dirk Ziegelmeier
1bb2539f74 Make options documentation a child of lwIP section 2016-07-27 20:49:19 +02:00
Dirk Ziegelmeier
0e6f2049ad Minor main_page.h cosmetics 2016-07-27 20:34:23 +02:00
Dirk Ziegelmeier
fb7998699d Minor doxygen options fix 2016-07-27 20:34:23 +02:00
Dirk Ziegelmeier
63fdb3bb62 Document opt.h - due to a bad bug in doxygen, I had to litter the whole file with "|| __DOXYGEN__" to make it work :-( 
Doxygen does not handle #ifndef foo #define foo #endif properly. It does not see the #define foo inside.
If someone has objections or a fix for it, please tell me.
 2016-07-27 20:34:23 +02:00
Dirk Ziegelmeier
31f941e172 More documentation updates 2016-07-27 20:34:23 +02:00
Dirk Ziegelmeier
0cb1d1144d Integrate README file into doxygen docs instead of duplicating its content in main_page.h 2016-07-27 19:09:52 +02:00
Dirk Ziegelmeier
aece68639a Integrate snmp_agent.txt in doxygen documentation, delete outdated file 2016-07-27 18:58:28 +02:00
Dirk Ziegelmeier
fc7aa7a247 Move content from contrib.h and upgrading.h to main_page.h 2016-07-27 13:07:29 +02:00
Dirk Ziegelmeier
6618189342 Add UPGRADING document to doxygen docs 2016-07-27 08:21:54 +02:00
Dirk Ziegelmeier
6b524367a3 Documentation review with Simon, minor changes 2016-07-27 08:05:38 +02:00
Dirk Ziegelmeier
7e4d934f7a Docs: generate search index 2016-07-26 23:14:38 +02:00
Dirk Ziegelmeier
7b770dd9b6 Document 6LoWPAN and SLIP netif 2016-07-26 20:10:17 +02:00
Dirk Ziegelmeier
7f43fcab71 Document system abstraction layer in doxygen module style 2016-07-26 20:03:04 +02:00
Dirk Ziegelmeier
c6831648e2 Document apps in doxygen module style, create more top-level categories to structure documentation 2016-07-26 19:30:05 +02:00
Dirk Ziegelmeier
8a9de94b1f Restructure documentation. Create two top-level sections for thread-safe and callback-style APIs. 2016-07-26 18:39:53 +02:00
Dirk Ziegelmeier
8643782e5d Document netif and lwIP in doxygen module style 2016-07-26 16:53:27 +02:00
Dirk Ziegelmeier
bd79f6c055 Document DNS, memory pools and PBUFs as modules 2016-07-26 16:40:13 +02:00
Dirk Ziegelmeier
59295be4ef Some more RAW API documentation updates 
Improve structure of documentation: PPP is now a module, too
 2016-07-26 13:53:59 +02:00
Dirk Ziegelmeier
d75ece2505 Add some of the .txt files in /doc subdir to doxygen documentation 2016-07-25 08:16:39 +02:00
Dirk Ziegelmeier
299a19e135 Add travis-ci Continous integration to docs 2016-07-20 20:06:45 +02:00
Dirk Ziegelmeier
cb99ca099e docs: RTF manual does not look good, deactivate it in lwip.Doxyfile 2016-07-19 08:27:09 +02:00
Dirk Ziegelmeier
2f950a7dcc Some documentation updates 2016-07-18 23:00:41 +02:00
Dirk Ziegelmeier
a324c7a8e4 Update #defines in lwip.Doxyfile to generate meaningful memp.c docs 2016-07-16 19:04:12 +02:00
Sylvain Rochet
d362e167c0 PPP, documentation: fix notify phase callback documentation 
A little grammar fix and an indentation fix in example code.
 2016-07-03 19:11:28 +02:00
Sylvain Rochet
a12c149093 PPP, documentation: add notify phase callback (PPP_NOTIFY_PHASE) documentation 
Notify phase callback, enabled using the PPP_NOTIFY_PHASE config option,
let user configure a callback that is called on each PPP internal state
change. This documents how to use it.
 2016-07-03 19:05:32 +02:00
Sylvain Rochet
e7069d6e82 PPP: introduce ppp_set_passive and ppp_set_silent 
There is two passive modes for PPPoS, passive more, for which we will
try to connect and then listen silently, and silent mode, for which we
will listen silently from the beginning.

Introduce ppp_set_passive and ppp_set_silent so the mode can be chosen
before connecting/listening.
 2016-07-02 21:03:48 +02:00
Sylvain Rochet
96296947fc PPP: introduce ppp_set_auth_required macro 
PPP auth required flag is currently hardcoded to true if PPP is
acting as a server and set to false if PPP is acting as a client.

This is probably the most wanted behavior, but since we now have the
ability to change that at runtime, allow users to do it.

It means we can now have a server which asks the client to authenticate
or vice versa. This is pretty unusual thought. What we don't support
yet is mutual authentication with a different set of user and password
per direction which is even less usual.
 2016-06-26 22:31:02 +02:00
Sylvain Rochet
8b9886bfe2 PPP, documentation: rework client configuration vs server configuration 
Better describe what should be done for a client session and for a
server session.
 2016-06-26 21:59:25 +02:00
Sylvain Rochet
9015c28406 PPP, DNS: introduce ppp_set_usepeerdns macro 
PPP use peer DNS setting is currently hardcoded to true if PPP is
acting as a client and set to false if PPP is actinf as a server.

This is probably the most wanted behavior, but since we now have the
ability to change that at runtime, allow users to do it.

We don't have a way to have a different default configuration if the
PPP PCB is going to be used as a client or as a server, therefore the
default configuration should be fine for both of them. Since enabling
peer DNS by default is dangerous for server mode, the default is now
not to ask for DNS servers and it should now be explicitely enabled
if needed, update the documentation accordingly.
 2016-06-26 21:36:48 +02:00
Sylvain Rochet
6fb074874b PPP, Documentation: add PPP server(listener) documentation 
Now that creating a PPP listener session is a bit less obvious than
before (but much versatile!), add documentation about the most common
way to setup a PPP listener.
 2016-06-26 20:32:28 +02:00