/**
  @page http server socket demonstration Readme file
 
  @verbatim
  ******************** (C) COPYRIGHT 2011 STMicroelectronics *******************
  * @file    httpserver socket/readme.txt 
  * @author  MCD Application Team
  * @version V1.0.0
  * @date    31-October-2011
  * @brief   Description of the STM32F4x7 http server socket demonstration.
  ******************************************************************************
  * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
  * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
  * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
  * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
  * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
  * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
  ******************************************************************************
   @endverbatim

@par Description

This directory contains a set of sources files that implement a web server
application, based on the socket API, for STM32F4x7 devices.

Please note that for http server socket demonstration, LwIP v1.3.2 is used a 
the TCP/IP stack and FreeRTOS v6.1.0 is used as the Real Time Kernel.

@par Project Directory contents

 - "inc": contains the demonstration firmware header files
    - inc/main.h               main config file
    - inc/stm32f4x7_eth_bsp.h  header for stm32f4x7_eth_bsp.c
    - inc/netconf.h            header for netconf.c
    - inc/lwipopts.h           LwIP stack configuration options
    - inc/FreeRTOSConfig.h     FreeRTOS configuration options
    - inc/fsdata.h             header for fsdata.c
    - inc/stm32f4xx_conf.h     Library Configuration file
    - inc/stm32f4x7_eth_conf.h STM32 Ethernet driver Configuration file
    - inc/stm32f4xx_it.h       Header for stm32f4xx_it.c
    - inc/fs.h                 header for fs.c
    - inc/httpserver-socket.h header for httpserver-socket.c
    - inc/serial_debug.h       header for serial_debug.c

  - "src": contains the demonstration firmware source files
    - src/main.c               main program file
    - src/stm32f4x7_eth_bsp.c  STM32F4x7 Ethernet hardware configuration
    - src/netconf.c            LwIP stack initializations
    - src/fsdata.c             ROM filesystem data (html pages)
    - src/system_stm32f4xx.c   STM32 system clock configuration file
    - src/stm32f4xx_it.c       STM32 Interrupt handlers
    - src/httpserver-socket.c httpserver socket main task
    - src/fs.c                 file system functions
    - src/serial_debug.c       retarget the printf function to the USART

 - "EWARM": contains preconfigured project for EWARM toolchain
 - "MDK-ARM": contains preconfigured project for MDK-ARM toolchain
 - "RIDE": contains preconfigured project for RIDE toolchain
 - "TASKING": contains preconfigured project for TASKING toolchain
 - "TrueSTUDIO": contains preconfigured project for TrueSTUDIO toolchain

@par Hardware and Software environment
  
  - This example has been tested with the following environments:
     - STM324xG-EVAL board
     - Http clients: Firefox Mozilla (v3.6 and later) or Microsoft Internet Explorer (v8 and later)
     - DHCP server: PC utility TFTPD32 (http://tftpd32.jounin.net/) is used as a DHCP server
  
  - STM324xG-EVAL Set-up
    - Connect STM324xG-EVAL board to remote PC (through a crossover ethernet cable)
      or to your local network (through a straight ethernet cable)
    - STM324xG-EVAL jumpers setting
        +==========================================================================================+
        +  Jumper |       MII mode configuration            |     RMII mode configuration(*)       +
        +==========================================================================================+
        +  JP5    | 2-3 provide 25MHz clock by MCO(PA8)     |  Not fitted                          +
        +         | 1-2 provide 25MHz clock by ext. Crystal |                                      +
        + -----------------------------------------------------------------------------------------+
        +  JP6    |          2-3                            |  1-2                                 +
        + -----------------------------------------------------------------------------------------+
        +  JP8    |          Open                           |  Close                               +
        + -----------------------------------------------------------------------------------------+
        +  JP22   | 1-2: RS232 is enabled                                                          +
        +==========================================================================================+
    (*) User have to provide the 50 MHz clock by soldering a 50 MHz oscillator (ref SM7745HEV-50.0M or
        equivalent) on the U3 footprint located under CN3 and also removing jumper on JP5. This oscillator
        is not provided with the board. 
        For more details, please refer to STM3240G-EVAL evaluation board User manual (UM1461).
    @Note: the default setting is MII mode, to change it to RMII mode refer to main.h file.


@par How to use it ?

In order to make the program work, you must do the following:
  1. Load the demonstration code in the STM32F4x7 Flash memory (see below)
  2. Refer to "AN3966 LwIP TCP/IP stack demonstration for STM32F4x7xx microcontrollers"
     to know how to use the demonstration

  In order to load the demonstration code, you have do the following:
   - EWARM
      - Open the Project.eww workspace
      - Rebuild all files: Project->Rebuild all
      - Load project image: Project->Debug
      - Run program: Debug->Go(F5)

   - RIDE
      - Open the Project.rprj project
      - Rebuild all files: Project->build project
      - Load project image: Debug->start(ctrl+D)
      - Run program: Debug->Run(ctrl+F9)

   - MDK-ARM
      - Open the Project.uvproj project
      - Rebuild all files: Project->Rebuild all target files
      - Load project image: Debug->Start/Stop Debug Session
      - Run program: Debug->Run (F5)

   - TASKING
      - Open TASKING toolchain.
      - Click on File->Import, select General->'Existing Projects into Workspace' 
        and then click "Next". 
      - Browse to TASKING workspace directory and select the project: 
          - STM324xG_EVAL: to configure the project for STM32F4xx devices.
      - Rebuild all project files: Select the project in the "Project explorer" 
        window then click on Project->build project menu.
      - Run program: Select the project in the "Project explorer" window then click 
        Run->Debug (F11)

   - TrueSTUDO
      - Open the TrueSTUDIO toolchain.
      - Click on File->Switch Workspace->Other and browse to TrueSTUDIO workspace directory.
      - Click on File->Import, select General->'Existing Projects into Workspace' and then click "Next".
      - Browse to the TrueSTUDIO workspace directory, select the project:
          - STM324xG_EVAL: to configure the project for STM32F4xx devices
      - Rebuild all project files: Select the project in the "Project explorer" 
        window then click on Project->build project menu.
      - Run program: Run->Debug (F11)
 
 * <h2><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h2>
 */