diff options
| author | Harout Hedeshian <harouth@codeaurora.org> | 2014-08-15 09:18:31 -0600 |
|---|---|---|
| committer | David Keitel <dkeitel@codeaurora.org> | 2016-03-22 11:05:20 -0700 |
| commit | c0e8ab74fe51863d6361a4dbc9b922e05ecfda14 (patch) | |
| tree | 5f606a66963d1bdf9f2331c938fc22b6561a3270 /net/rmnet_data | |
| parent | fd9a8748f12d426a9f76284dc7466d74bf42f3e7 (diff) | |
net: rmnet_data: Add documentation for configuration structures
Better document the configuration structures and the element usage.
Anticipating more elements being added in the near term.
Change-Id: I5ca90b7a776072d6b1ac4838782cada38f4fea3b
Signed-off-by: Harout Hedeshian <harouth@codeaurora.org>
Diffstat (limited to 'net/rmnet_data')
| -rw-r--r-- | net/rmnet_data/rmnet_data_config.h | 33 |
1 files changed, 31 insertions, 2 deletions
diff --git a/net/rmnet_data/rmnet_data_config.h b/net/rmnet_data/rmnet_data_config.h index ee41de50a999..f947cf164149 100644 --- a/net/rmnet_data/rmnet_data_config.h +++ b/net/rmnet_data/rmnet_data_config.h @@ -22,6 +22,17 @@ #define RMNET_DATA_MAX_LOGICAL_EP 256 +/** + * struct rmnet_logical_ep_conf_s - Logical end-point configuration + * + * @refcount: Reference count for this endpoint. 0 signifies the endpoint is not + * configured for use + * @rmnet_mode: Specifies how the traffic should be finally delivered. Possible + * options are available in enum rmnet_config_endpoint_modes_e + * @mux_id: Virtual channel ID used by MAP protocol + * @egress_dev: Next device to deliver the packet to. Exact usage of this + * parmeter depends on the rmnet_mode + */ struct rmnet_logical_ep_conf_s { uint8_t refcount; uint8_t rmnet_mode; @@ -29,12 +40,30 @@ struct rmnet_logical_ep_conf_s { struct net_device *egress_dev; }; +/** + * struct rmnet_phys_ep_conf_s - Physical endpoint configuration + * One instance of this structure is instantiated for each net_device associated + * with rmnet_data. + * + * @dev: The device which is associated with rmnet_data. Corresponds to this + * specific instance of rmnet_phys_ep_conf_s + * @local_ep: Default non-muxed endpoint. Used for non-MAP protocols/formats + * @muxed_ep: All multiplexed logical endpoints associated with this device + * @ingress_data_format: RMNET_INGRESS_FORMAT_* flags from rmnet_data.h + * @egress_data_format: RMNET_EGRESS_FORMAT_* flags from rmnet_data.h + * + * @egress_agg_size: Maximum size (bytes) of data which should be aggregated + * @egress_agg_count: Maximum count (packets) of data which should be aggregated + * Smaller of the two parameters above are chosen for + * aggregation + * @tail_spacing: Guaranteed padding (bytes) when de-aggregating ingress frames + */ struct rmnet_phys_ep_conf_s { struct net_device *dev; struct rmnet_logical_ep_conf_s local_ep; struct rmnet_logical_ep_conf_s muxed_ep[RMNET_DATA_MAX_LOGICAL_EP]; - uint32_t ingress_data_format; - uint32_t egress_data_format; + uint32_t ingress_data_format; + uint32_t egress_data_format; /* MAP specific */ uint16_t egress_agg_size; |