Permalink
Browse files

Fix and update documetaion.

  • Loading branch information...
asterix24 committed Feb 2, 2012
1 parent 3de6ba5 commit 0144d1ba02537cfca6831ca69748b156347084ff
Showing with 43 additions and 21 deletions.
  1. +5 −0 bertos/drv/sipo.h
  2. +31 −21 bertos/net/syslog.h
  3. +7 −0 doc/general-introduction
View
@@ -29,6 +29,9 @@
* Copyright 2009 Develer S.r.l. (http://www.develer.com/)
*
* -->
* \defgroup sipo_driver SIPO driver
* \ingroup drivers
* \{
*
* \brief Generic Serial-in, Parallel-out implementation (SIPO).
*
@@ -166,5 +169,7 @@ INLINE Sipo * SIPO_CAST(KFile *fd)
void sipo_init_1(Sipo *fd);
void sipo_init_3(Sipo *fd, SipoMap dev, uint8_t settings);
/** \} */ //defgroup sipo_driver
#endif /* DRV_SIPO_H */
View
@@ -30,36 +30,44 @@
*
* -->
*
* \brief SYSLOG log all debug message in the BeRTOS code, with the
* respective log level, to one syslog server on the udp protocol.
* \defgroup syslog_module SYSLOG module.
* \ingroup net
* \{
*
* \brief SYSLOG System Log modulelog.
*
* This module allow the user to send all debug message to one syslog server.
* The only things that we need to use it, is to have a valid ethernet interface and the
* ip address of the remote syslog server, then the syslog module redirect all LOG_* (INFO, WARN, ERR)
* message to syslog server, optionally we can send both message on serial and on syslog.
*
* The usage pattern is as follows:
* \code
* // Init the network, es using dhcp:
* //Init the network, es using dhcp:
*
* // Initialize TCP/IP stack
* tcpip_init(NULL, NULL);
* //Initialize TCP/IP stack
* tcpip_init(NULL, NULL);
*
* // Bring up the network interface
* netif_add(&netif, &ipaddr, &netmask, &gw, NULL, ethernetif_init, tcpip_input);
* netif_set_default(&netif);
* netif_set_up(&netif);
* //Bring up the network interface
* netif_add(&netif, &ipaddr, &netmask, &gw, NULL, ethernetif_init, tcpip_input);
* netif_set_default(&netif);
* netif_set_up(&netif);
*
* dhcp_start(&netif);
* while (!netif.ip_addr.addr)
* timer_delay(DHCP_FINE_TIMER_MSECS);
* dhcp_start(&netif);
* while (!netif.ip_addr.addr)
* timer_delay(DHCP_FINE_TIMER_MSECS);
*
* // lwip address struct
* struct ip_addr server_addr;
* // convert address to ip_address
* IP4_ADDR(&server_addr, 192, 168, 0, 2);
* //lwip address struct
* struct ip_addr server_addr;
* // convert address to ip_address
* IP4_ADDR(&server_addr, 192, 168, 0, 2);
*
* // init the syslog module
* syslog_init(&syslog, server_addr);
* //init the syslog module
* syslog_init(&syslog, server_addr);
*
* // now all LOG_*(message) are logged on
* // syslog server.
* // see the cfg_syslog.h for all settings.
* //now all LOG_*(message) are logged on
* //syslog server.
* //see the cfg_syslog.h for all settings.
* \endcode
*
*
@@ -94,4 +102,6 @@ int syslog_printf(const char *fmt, ...);
void syslog_init(SysLog *syslog_ctx, struct ip_addr addr);
/** \} */ //defgroup syslog_module.
#endif /* NET_SYSLOG_H */
View
@@ -172,3 +172,10 @@ value.
/*!
* \defgroup struct Embedded optimized general purpose data types
*/
/*!
* \defgroup net Network utilities
*
* This section describes various utilities to be used in BeRTOS to
* write application with network.
*/

0 comments on commit 0144d1b

Please sign in to comment.