wm_dhcp_server.h 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. /**
  2. * @file wm_dhcp_server.h
  3. *
  4. * @brief DHCP SERVER
  5. *
  6. * @author winnermicro
  7. *
  8. * Copyright (c) 2015 Winner Microelectronics Co., Ltd.
  9. */
  10. #ifndef WM_DHCP_SERVER_H
  11. #define WM_DHCP_SERVER_H
  12. /**
  13. * @defgroup APP_APIs APP APIs
  14. * @brief APP APIs
  15. */
  16. /**
  17. * @addtogroup APP_APIs
  18. * @{
  19. */
  20. /**
  21. * @defgroup DHCPS_APIs DHCPS APIs
  22. * @brief DHCP server APIs
  23. */
  24. /**
  25. * @addtogroup DHCPS_APIs
  26. * @{
  27. */
  28. /**
  29. * @brief This function is used to start DHCP Server for a network
  30. interface
  31. *
  32. * @param None
  33. *
  34. * @retval WM_SUCCESS success
  35. * @retval WM_FAILED failed
  36. *
  37. * @note None
  38. */
  39. s8 tls_dhcps_start(void);
  40. /**
  41. * @brief This function is used to stop DHCP server
  42. *
  43. * @param[in] None
  44. *
  45. * @return None
  46. *
  47. * @note None
  48. */
  49. void tls_dhcps_stop(void);
  50. /**
  51. * @brief This function is used to get station's IP address by
  52. MAC address
  53. *
  54. * @param[in] *mac STA's MAC address
  55. *
  56. * @retval ip_addr STA's IP address
  57. * @retval NULL Not found match IP with MAC address
  58. *
  59. * @note None
  60. */
  61. ip_addr_t *tls_dhcps_getip(const u8 *mac);
  62. /**
  63. * @brief This function is used to set DHCP server's DNS address
  64. *
  65. * @param[in] numdns the index of the DNS server to set must be 0 or 1
  66. *
  67. * @return None
  68. *
  69. * @note None
  70. */
  71. void tls_dhcps_setdns(u8 numdns);
  72. /**
  73. * @}
  74. */
  75. /**
  76. * @}
  77. */
  78. #endif /* WM_DHCP_SERVER_H */