Commit Graph

105 Commits

Author SHA1 Message Date
Dirk Ziegelmeier
75c5829a57 Lots of documentation updates 2016-06-22 20:46:19 +02:00
Dirk Ziegelmeier
8dc77ef558 doxygen updates - include IPv6 in documentation. Exclude include/netif/ppp/polarssl.
Convert TODO -> @todo
2016-06-22 20:18:23 +02:00
Dirk Ziegelmeier
606b6990ff Reorganize links in doxygen documentation 2016-06-12 10:41:44 +02:00
Dirk Ziegelmeier
270378387c Fix broken link in doxygen docs 2016-06-12 10:39:33 +02:00
Dirk Ziegelmeier
5a056cc861 Update main documentation page 2016-06-11 22:50:53 +02:00
Dirk Ziegelmeier
a364427ae5 Resurrect doxygen main page (main_page.h) 2016-05-24 21:27:38 +02:00
Dirk Ziegelmeier
6c8c3fd48c Fix more doxygen errors 2016-05-23 21:38:18 +02:00
Dirk Ziegelmeier
f4bf0dff85 Update doxygen file to work with recent doxygen versions 2016-05-23 20:16:20 +02:00
Sylvain Rochet
9f69bf82df PPP, documentation, updated to recent changes
Fixed PPPAPI include path.
Improved note about SIO's farewell.
2016-05-11 10:56:49 +02:00
Sylvain Rochet
45c6279bb0 PPP, documentation, update next release version
Next release will be 2.0.0 instead of 1.5.0, change that in the
documentation.
2016-05-11 00:42:59 +02:00
Sylvain Rochet
1ee574944c PPP, Documentation, fixed mistake about pppos_input_sys
Woops, pppos_input_sys is an internal function which must not be called
from lwIP user application. The correct function to use is
pppos_input_tcpip.
2016-01-18 12:45:40 +01:00
Sylvain Rochet
495fc61a34 Documentation: SNMP: update to recent changes
Remove snmp_init(), it is called by lwip_init().

Remove snmp_inc_sysuptime() and snmp_add_sysuptime(), they do not exist
anymore, MIB2 is now using sys_now().
2015-10-04 11:02:17 +02:00
Sylvain Rochet
9e0202b38f PPP, PPP_MAXIDLEFLAG is now in ms instead of jiffies
Jiffies isn't really a humanly readable value and it means the default
PPP_MAXIDLEFLAG period depends on the platform "jiffies" frequency,
which isn't nice.

Change PPP_MAXIDLEFLAG to use ms instead of jiffies, the current
PPP_MAXIDLEFLAG default (100 ms), looks like a sane value and is
left unchanged.
2015-09-26 23:01:15 +02:00
Sylvain Rochet
e588dfdbce documentation: savannah: updated for Git 2015-09-22 21:52:44 +02:00
Sylvain Rochet
2f40d19193 trivial CVS to Git renaming 2015-09-22 21:09:57 +02:00
Sylvain Rochet
9882dd5eff documentation: rawapi: more syntax fixes
ethernet -> Ethernet
ip -> IP
LwIP -> lwIP
lwip -> lwIP
it's use. -> its use.
2015-09-22 00:27:56 +02:00
Sylvain Rochet
bb92a059b6 documentation: rawapi: syntax fixes
udp -> UDP
tcp -> TCP
2015-09-22 00:20:49 +02:00
Sylvain Rochet
47a579f54f documentation: rawapi: improved documentation on multithreading state
Based from the current lwIP wiki and my own, improved documentation about
the current lwIP multithreading state.
2015-09-21 23:54:16 +02:00
Sylvain Rochet
6746f1d13c documentation: rawapi: update to current lwIP design
*_init() -> lwip_init()
*tmr() -> sys_check_timeouts()
netif_set_link_up() / netif_up() clarification
updated netif_add() prototype
source code style fix in examples
2015-09-21 23:19:18 +02:00
Sylvain Rochet
74939c20c4 doc: contrib: CVS -> Git, punctuation fixes 2015-09-21 22:40:56 +02:00
Sylvain Rochet
b55412a0c4 PPP, PPPoS, replaced static sio_write() calls to a user defined callback
The overall lwIP design on data flows (netif,udp,tcp) is to use a user
defined callback to get data from stack and a static function to send
data to stack, which makes perfect sense. The SIO port was an exception,
the PPP stack never really used the SIO port by only using the
sio_send() function (and the ignominious sio_read_abort() function a
while back).

The way the SIO port is currently designed adds a tight coupling between
the lwIP port and the user code if the user need to do specific user
code if the current uart used is the PPPoS uart, which is not nice,
especially because all the lwIP stack is quite clean at this subject.

While we are at stabilizing the PPP API, change this behavior before
it's too late by replacing the static sio_write() calls to a user
defined callback.
2015-09-13 17:53:16 +02:00
Sylvain Rochet
81d3337681 Documentation, add pppapi.h to thread-safe header whitelist 2015-09-12 14:57:05 +02:00
goldsimon
cb28380f47 Add doxygen config + main-file used by Frédéric to create http://www.nongnu.org/lwip/ for 1.3.0 (see https://lists.gnu.org/archive/html/lwip-users/2013-01/msg00062.html) - just so that it doesn't get lost 2015-08-19 15:43:46 +02:00
Sylvain Rochet
43c38a5aeb PPP, Documentation, add that we support MPPE 2015-08-07 16:53:27 +02:00
Edgar Bonet
fb456e00ac Fix documentation of TCP_WRITE_FLAG_MORE.
The description of the flag was erroneous in src/core/tcp_out.c, and
self-contradictory in doc/rawapi.txt.
2015-08-05 21:20:34 +02:00
Sylvain Rochet
ee752ab1ce PPP, PPPoS, renamed PPP_INPROC_MULTITHREADED to PPP_INPROC_IRQ_SAFE
Follow-up of the #44565 bug fix, renamed the misnamed
PPP_INPROC_MULTITHREADED to PPP_INPROC_IRQ_SAFE because it is
IRQ safe but not thread safe.

Updated PPP documentation which now clearly state when and how
this feature can be used.
2015-03-19 21:43:55 +01:00
Sylvain Rochet
0da64f430e PPP, Documentation, improved PPP_INPROC_MULTITHREADED part 2015-03-12 00:16:03 +01:00
Sylvain Rochet
d50494f274 PPP, Documentation, added DNS change 2015-03-08 14:15:20 +01:00
Sylvain Rochet
4b5e867a69 PPP: Documentation: replaced deprecated ip_ntoa() to ipaddr_ntoa() 2015-03-08 13:57:26 +01:00
Sylvain Rochet
7857c22277 PPP, Documentation, updated 2015-03-08 01:09:44 +01:00
Sylvain Rochet
2731976a95 PPP, renamed ppp_open to ppp_connect
Makes it clear we are initiating the PPP session with ppp_connect
(i.e. acting as a PPP client) so there is no confusion possible
between ppp_connect and ppp_listen.
2015-03-01 10:53:08 +01:00
Sylvain Rochet
4be7fccad3 PPP, CORE, ppp_close() and ppp_sighup() ended up sharing almost everything, merged
Merged ppp_sighup() to ppp_close() using an optional argument  "nocarrier"
on ppp_close().
2015-02-22 14:25:36 +01:00
Sylvain Rochet
9052511c86 PPP, Documentation, fixed PPP_INPROC_MULTITHREADED default status 2015-02-21 18:41:39 +01:00
Sylvain Rochet
c5973dd411 PPP, Documentation, minor fixes 2015-02-21 00:05:38 +01:00
Sylvain Rochet
e5f38bf391 PPP, added PPP documentation 2015-02-21 00:01:43 +01:00
Simon Goldschmidt
eb6bcdb3ee Removed the demand to post trivial patches to lwip-users, things keep getting lost there. 2013-04-24 20:55:45 +02:00
goldsimon
09ac68c196 Fixed documentation after changing sys arch prototypes for 1.4.0 2011-07-04 19:33:33 +00:00
goldsimon
12c2d7e4cf - changed "struct ip_addr" to "ip_addr_t";
- tcp_accepted(): added a note to call this on the listening pcb, not the connection pcb;
- tcp_write(): change last parameter from "copy" to "apiflags", documented the apiflags
2011-06-25 18:39:37 +00:00
goldsimon
036cb26fa3 sys_arch_timeouts() is not needed any more. 2011-04-20 11:31:07 +00:00
goldsimon
4e3b2b9f6b Fixed bug #32561 tcp_poll argument definition out-of-order in documentation 2011-02-21 19:26:57 +00:00
goldsimon
4d1ff2418e Fixed bug #29271 (Application can't re-use pbufs) by updating the doc to not allow reusing pbufs after passing them to a send function 2010-05-04 19:36:49 +00:00
goldsimon
d2c632fb18 patch #7145: Various typos in SNMP files 2010-04-14 19:13:35 +00:00
goldsimon
0644c4c08e Fixed bug #27871: Calling tcp_abort() in recv callback can lead to accessing unallocated memory. As a consequence, ERR_ABRT means the application has called tcp_abort()! 2010-01-27 17:22:06 +00:00
fbernon
ce5699f41b minor changes: typos and coding style 2009-07-09 10:21:16 +00:00
goldsimon
aefeba3fc0 Added note about printf formatter defines 2009-05-20 18:59:05 +00:00
goldsimon
72e9cf53e7 Added netbuf.h to files that may be called from any thread 2009-05-07 14:20:37 +00:00
goldsimon
e66d315c9b Added more threading info 2009-05-07 14:15:51 +00:00
goldsimon
bdd5586cee Added a word or two on threading, which should be sufficient to close task #6683 2009-05-05 19:33:41 +00:00
goldsimon
029b786c77 Fixed bug #26069: Corrected documentation: if tcp_connect fails, pcb->err is called, not pcb->connected (with an error code). 2009-04-21 19:15:16 +00:00
jifl
03aa8270a6 document that eth drivers input function should be ethernet_input 2008-02-18 12:27:51 +00:00