Update README.md and warn user about the default timer used.

Signed-off-by: Frederic.Pillon <[email protected]>

Author: fpistm

README.md

@@ -5,24 +5,28 @@
 With an STM32 board with Ethernet compatibility, this library allows a STM32
 board (NUCLEO, DISCOVERY, ...) to connect to the internet.  
 
-For more information about this library please visit us at
-http://www.arduino.cc/en/Reference/Ethernet
+This library follows the Ethernet API from Arduino.<br>
+For more information about it please visit: http://www.arduino.cc/en/Reference/Ethernet
 
 ## Note
 
-The library is based on LwIP, a Lightweight TCP/IP stack.  
+The library is based on LwIP, a Lightweight TCP/IP stack, available here:
+
 http://git.savannah.gnu.org/cgit/lwip.git
+
 The LwIP has been ported as Arduino library. The STM32Ethernet library depends
 on it.
 
-EthernetClass::maintain() in no more required to renew IP address from DHCP.  
+`EthernetClass::maintain()` in no more required to renew IP address from DHCP.<br>
 It is done automatically by the LwIP stack in a background task.  
 
-An Idle task is required by the LwIP stack to handle timer and data reception.
-This idle task is called inside the main loop in background by the function
-stm32_eth_scheduler(). Be careful to not lock the system inside the function
-loop() where LwIP could never be updated. Call Ethernet::schedule() performs an
-update of the LwIP stack.
+An Idle task is required by the LwIP stack to handle timer and data reception.<br>
+This idle task is called inside a timer callback each 1 ms by the
+function `stm32_eth_scheduler()`.<br>
+A `DEFAULT_ETHERNET_TIMER` is set in the library to `TIM14`.<br>
+`DEFAULT_ETHERNET_TIMER` can be redefined in the core variant.<br>
+Be careful to not lock the system in a function which disabling IRQ.<br>
+Call `Ethernet::schedule()` performs an update of the LwIP stack.<br>
 
 ## Wiki
 

src/utility/stm32_eth.c

@@ -60,9 +60,15 @@
 /* Maximum number of retries for DHCP request */
 #define MAX_DHCP_TRIES  4
 
-/* Timer used to call the scheduler */
+/*
+ * Defined a default timer used to call ethernet scheduler at regular interval
+ * Could be redefined in the variant
+ * Note: This is planned to extend Timer API's of the Arduino STM32 core
+ *       They could be used for this library when available
+ */
 #ifndef DEFAULT_ETHERNET_TIMER
 #define DEFAULT_ETHERNET_TIMER  TIM14
+#warning "Default timer used to call ethernet scheduler at regular interval: TIM14"
 #endif
 
 /* Ethernet configuration: user parameters */