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
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
goldsimon
52e8ec03ba
Clarify that timeout == 0 means wait forever
2008-01-27 11:28:44 +00:00
fbernon
8d0f689cb5
Minor changes: typo in doc files.
2008-01-21 17:00:07 +00:00
fbernon
7518acf634
rawapi.txt, api_msg.c, tcp.c, tcp_in.c, tcp.h: changes for task #7675 "Enable to refuse data on a TCP_EVENT_RECV call". Important, behavior changes for the tcp_recv callback (see rawapi.txt).
2008-01-14 21:07:08 +00:00
fbernon
5941b3c86e
sys_arch.txt, api.h, api_lib.c, api_msg.h, api_msg.c, tcpip.c, sys.h, opt.h: Introduce changes for task #7490 "Add return value to sys_mbox_post" with some modifications in the sys_mbox api: sys_mbox_new take a "size" parameters which indicate the number of pointers query by the mailbox. There is three defines in opt.h to indicate sizes for tcpip::mbox, netconn::recvmbox, and for the netconn::acceptmbox. Port maintainers, you can decide to just add this new parameter in your implementation, but to ignore it to keep the previous behavior. The new sys_mbox_trypost function return a value to know if the mailbox is full or if the message is posted. Take a look to sys_arch.txt for more details. This new function is used in tcpip_input (so, can be called in an interrupt context since the function is not blocking), and in recv_udp and recv_raw.
2008-01-05 21:10:32 +00:00
fbernon
32005617b9
rawapi.txt, api.h, api_lib.c, api_msg.h, api_msg.c, sockets.c, tcp.h, tcp.c, tcp_in.c, init.c, opt.h: rename backlog options with TCP_ prefix, limit the "backlog" parameter in an u8_t, 0 is interpreted as "smallest queue", add documentation in the rawapi.txt file.
2008-01-04 22:18:27 +00:00
fbernon
3f96a15fd4
Minor changes (tabs)
2007-12-03 21:44:51 +00:00
fbernon
1a104762ea
Update documentation for the SNMP uptime timestamp.
2007-10-10 08:12:19 +00:00
fbernon
2a5209bb5a
Update documentation for the SNMP uptime timestamp.
2007-10-10 08:05:34 +00:00
goldsimon
199648ff37
Changed initialization: many init functions are not needed any more since we now rely on the compiler initializing global and static variables to zero!
2007-10-09 19:59:56 +00:00
fbernon
90a3f88c08
Change parameters list for sys_thread_new (see "task #7252 : Create sys_thread_new_ex()"). Two new parameters have to be provided: a task name, and a task stack size. For this one, since it's platform dependant, you could define the best one for you in your lwipopts.h. For port maintainers, you can just add these new parameters in your sys_arch.c file, and but it's not mandatory, use them in your OS specific functions.
2007-09-05 16:14:28 +00:00
fbernon
231d965bcb
Minor fix (use ETHARP_HWADDR_LEN)
2007-08-31 09:02:53 +00:00
jifl
58b3b0603d
Note succesful error return for sys_arch_mbox_tryfetch
2007-04-12 02:50:08 +00:00
jifl
9d43d74ee3
Document new sys_arch_mbox_tryfetch requirement for ports
2007-04-12 01:30:53 +00:00
fbernon
e075581d76
no message
2007-03-02 19:35:15 +00:00
christiaans
5fcf6418cf
Added warning about using mem_malloc in sys_arch.c, cold case bug #1913 .
2006-10-24 09:10:26 +00:00
christiaans
bc182cab7c
Removed EXPERIMENTAL status.
2006-10-13 12:00:35 +00:00
christiaans
c5bd3f5e3b
Documented TRAP destination setup.
2006-09-07 14:46:41 +00:00
christiaans
8559f3e583
MIB-2 object values near to completion, just committing for keeping the flame alive.
2006-08-11 14:16:36 +00:00
christiaans
54bb20b486
Added SNMP statistics to struct netif and changed SNMP macro glue.
2006-07-14 09:58:02 +00:00
christiaans
6b2979027e
Add preliminairy documentation for the SNMP agent.
2006-07-07 08:03:04 +00:00
likewise
9a23e9839b
Initial commit of FILES in doc/
2006-04-28 11:45:00 +00:00
christiaans
ed1e3899af
Added optimalization hints.
2006-03-31 09:26:42 +00:00
likewise
b5340dd739
Updated CVS server host names and documentation about pserver anonymous, SSH non-anonymous access to it.
2005-12-12 09:32:47 +00:00
