modem: modem_ppp: Update documentation (91235599) · Commits · Wenxi XU / zephyr

include/zephyr/modem/ppp.h

+29 −2

Original line number	Diff line number	Diff line
		@@ -20,6 +20,20 @@
		extern "C" {
		#endif

		/**
		* @brief Modem PPP
		* @defgroup modem_ppp Modem PPP
		* @ingroup modem
		* @{
		*/

		/** L2 network interface init callback */
		typedef void (modem_ppp_init_iface)(struct net_if iface);

		/**
		* @cond INTERNAL_HIDDEN
		*/

		enum modem_ppp_receive_state {
		/* Searching for start of frame and header */
		MODEM_PPP_RECEIVE_STATE_HDR_SOF = 0,
		@@ -57,8 +71,6 @@ enum modem_ppp_transmit_state {
		MODEM_PPP_TRANSMIT_STATE_EOF,
		};

		typedef void (modem_ppp_init_iface)(struct net_if iface);

		struct modem_ppp {
		/* Network interface instance is bound to */
		struct net_if *iface;
		@@ -103,6 +115,10 @@ struct modem_ppp {
		#endif
		};

		/**
		* @endcond
		*/

		/**
		* @brief Attach pipe to instance and connect
		*
		@@ -126,6 +142,10 @@ struct net_if modem_ppp_get_iface(struct modem_ppp ppp);
		*/
		void modem_ppp_release(struct modem_ppp *ppp);

		/**
		* @cond INTERNAL_HIDDEN
		*/

		/**
		* @brief Initialize modem PPP instance device
		* @param dev Device instance associated with network interface
		@@ -133,6 +153,10 @@ void modem_ppp_release(struct modem_ppp *ppp);
		*/
		int modem_ppp_init_internal(const struct device *dev);

		/**
		* @endcond
		*/

		/**
		* @brief Define a modem PPP module and bind it to a network interface
		*
		@@ -163,6 +187,9 @@ int modem_ppp_init_internal(const struct device *dev);
		modem_ppp_init_internal, NULL, &_name, NULL, _prio, &modem_ppp_ppp_api, \
		PPP_L2, NET_L2_GET_CTX_TYPE(PPP_L2), _mtu)

		/**
		* @}
		*/

		#ifdef __cplusplus
		}