rmnet_map.h 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  1. /* Copyright (c) 2013-2020, The Linux Foundation. All rights reserved.
  2. *
  3. * This program is free software; you can redistribute it and/or modify
  4. * it under the terms of the GNU General Public License version 2 and
  5. * only version 2 as published by the Free Software Foundation.
  6. *
  7. * This program is distributed in the hope that it will be useful,
  8. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. * GNU General Public License for more details.
  11. */
  12. #ifndef _RMNET_MAP_H_
  13. #define _RMNET_MAP_H_
  14. #include <linux/skbuff.h>
  15. #include "rmnet_config.h"
  16. struct rmnet_map_control_command {
  17. u8 command_name;
  18. u8 cmd_type:2;
  19. u8 reserved:6;
  20. u16 reserved2;
  21. u32 transaction_id;
  22. union {
  23. struct {
  24. u16 ip_family:2;
  25. u16 reserved:14;
  26. __be16 flow_control_seq_num;
  27. __be32 qos_id;
  28. } flow_control;
  29. u8 data[0];
  30. };
  31. } __aligned(1);
  32. enum rmnet_map_commands {
  33. RMNET_MAP_COMMAND_NONE,
  34. RMNET_MAP_COMMAND_FLOW_DISABLE,
  35. RMNET_MAP_COMMAND_FLOW_ENABLE,
  36. RMNET_MAP_COMMAND_FLOW_START = 7,
  37. RMNET_MAP_COMMAND_FLOW_END = 8,
  38. /* These should always be the last 2 elements */
  39. RMNET_MAP_COMMAND_UNKNOWN,
  40. RMNET_MAP_COMMAND_ENUM_LENGTH
  41. };
  42. enum rmnet_map_v5_header_type {
  43. RMNET_MAP_HEADER_TYPE_UNKNOWN,
  44. RMNET_MAP_HEADER_TYPE_COALESCING = 0x1,
  45. RMNET_MAP_HEADER_TYPE_CSUM_OFFLOAD = 0x2,
  46. RMNET_MAP_HEADER_TYPE_ENUM_LENGTH
  47. };
  48. enum rmnet_map_v5_close_type {
  49. RMNET_MAP_COAL_CLOSE_NON_COAL,
  50. RMNET_MAP_COAL_CLOSE_IP_MISS,
  51. RMNET_MAP_COAL_CLOSE_TRANS_MISS,
  52. RMNET_MAP_COAL_CLOSE_HW,
  53. RMNET_MAP_COAL_CLOSE_COAL,
  54. };
  55. enum rmnet_map_v5_close_value {
  56. RMNET_MAP_COAL_CLOSE_HW_NL,
  57. RMNET_MAP_COAL_CLOSE_HW_PKT,
  58. RMNET_MAP_COAL_CLOSE_HW_BYTE,
  59. RMNET_MAP_COAL_CLOSE_HW_TIME,
  60. RMNET_MAP_COAL_CLOSE_HW_EVICT,
  61. };
  62. /* Main QMAP header */
  63. struct rmnet_map_header {
  64. u8 pad_len:6;
  65. u8 next_hdr:1;
  66. u8 cd_bit:1;
  67. u8 mux_id;
  68. __be16 pkt_len;
  69. } __aligned(1);
  70. /* QMAP v5 headers */
  71. struct rmnet_map_v5_csum_header {
  72. u8 next_hdr:1;
  73. u8 header_type:7;
  74. u8 hw_reserved:5;
  75. u8 priority:1;
  76. u8 hw_reserved_bit:1;
  77. u8 csum_valid_required:1;
  78. __be16 reserved;
  79. } __aligned(1);
  80. struct rmnet_map_v5_nl_pair {
  81. __be16 pkt_len;
  82. u8 csum_error_bitmap;
  83. u8 num_packets;
  84. } __aligned(1);
  85. /* NLO: Number-length object */
  86. #define RMNET_MAP_V5_MAX_NLOS (6)
  87. #define RMNET_MAP_V5_MAX_PACKETS (48)
  88. struct rmnet_map_v5_coal_header {
  89. u8 next_hdr:1;
  90. u8 header_type:7;
  91. u8 reserved1:4;
  92. u8 num_nlos:3;
  93. u8 csum_valid:1;
  94. u8 close_type:4;
  95. u8 close_value:4;
  96. u8 reserved2:4;
  97. u8 virtual_channel_id:4;
  98. struct rmnet_map_v5_nl_pair nl_pairs[RMNET_MAP_V5_MAX_NLOS];
  99. } __aligned(1);
  100. /* QMAP v4 headers */
  101. struct rmnet_map_dl_csum_trailer {
  102. u8 reserved1;
  103. u8 valid:1;
  104. u8 reserved2:7;
  105. u16 csum_start_offset;
  106. u16 csum_length;
  107. __be16 csum_value;
  108. } __aligned(1);
  109. struct rmnet_map_ul_csum_header {
  110. __be16 csum_start_offset;
  111. u16 csum_insert_offset:14;
  112. u16 udp_ind:1;
  113. u16 csum_enabled:1;
  114. } __aligned(1);
  115. struct rmnet_map_control_command_header {
  116. u8 command_name;
  117. u8 cmd_type:2;
  118. u8 reserved:5;
  119. u8 e:1;
  120. u16 source_id:15;
  121. u16 ext:1;
  122. u32 transaction_id;
  123. } __aligned(1);
  124. struct rmnet_map_flow_info_le {
  125. __be32 mux_id;
  126. __be32 flow_id;
  127. __be32 bytes;
  128. __be32 pkts;
  129. } __aligned(1);
  130. struct rmnet_map_flow_info_be {
  131. u32 mux_id;
  132. u32 flow_id;
  133. u32 bytes;
  134. u32 pkts;
  135. } __aligned(1);
  136. struct rmnet_map_dl_ind_hdr {
  137. union {
  138. struct {
  139. u32 seq;
  140. u32 bytes;
  141. u32 pkts;
  142. u32 flows;
  143. struct rmnet_map_flow_info_le flow[0];
  144. } le __aligned(1);
  145. struct {
  146. __be32 seq;
  147. __be32 bytes;
  148. __be32 pkts;
  149. __be32 flows;
  150. struct rmnet_map_flow_info_be flow[0];
  151. } be __aligned(1);
  152. } __aligned(1);
  153. } __aligned(1);
  154. struct rmnet_map_dl_ind_trl {
  155. union {
  156. __be32 seq_be;
  157. u32 seq_le;
  158. } __aligned(1);
  159. } __aligned(1);
  160. struct rmnet_map_dl_ind {
  161. u8 priority;
  162. void (*dl_hdr_handler_v2)(struct rmnet_map_dl_ind_hdr *dlhdr,
  163. struct rmnet_map_control_command_header *qcmd);
  164. void (*dl_trl_handler_v2)(struct rmnet_map_dl_ind_trl *dltrl,
  165. struct rmnet_map_control_command_header *qcmd);
  166. struct list_head list;
  167. };
  168. #define RMNET_MAP_GET_MUX_ID(Y) (((struct rmnet_map_header *) \
  169. (Y)->data)->mux_id)
  170. #define RMNET_MAP_GET_CD_BIT(Y) (((struct rmnet_map_header *) \
  171. (Y)->data)->cd_bit)
  172. #define RMNET_MAP_GET_PAD(Y) (((struct rmnet_map_header *) \
  173. (Y)->data)->pad_len)
  174. #define RMNET_MAP_GET_CMD_START(Y) ((struct rmnet_map_control_command *) \
  175. ((Y)->data + \
  176. sizeof(struct rmnet_map_header)))
  177. #define RMNET_MAP_GET_LENGTH(Y) (ntohs(((struct rmnet_map_header *) \
  178. (Y)->data)->pkt_len))
  179. #define RMNET_MAP_DEAGGR_SPACING 64
  180. #define RMNET_MAP_DEAGGR_HEADROOM (RMNET_MAP_DEAGGR_SPACING / 2)
  181. #define RMNET_MAP_COMMAND_REQUEST 0
  182. #define RMNET_MAP_COMMAND_ACK 1
  183. #define RMNET_MAP_COMMAND_UNSUPPORTED 2
  184. #define RMNET_MAP_COMMAND_INVALID 3
  185. #define RMNET_MAP_NO_PAD_BYTES 0
  186. #define RMNET_MAP_ADD_PAD_BYTES 1
  187. static inline unsigned char *rmnet_map_data_ptr(struct sk_buff *skb)
  188. {
  189. /* Nonlinear packets we receive are entirely within frag 0 */
  190. if (skb_is_nonlinear(skb) && skb->len == skb->data_len)
  191. return skb_frag_address(skb_shinfo(skb)->frags);
  192. return skb->data;
  193. }
  194. static inline struct rmnet_map_control_command *
  195. rmnet_map_get_cmd_start(struct sk_buff *skb)
  196. {
  197. unsigned char *data = rmnet_map_data_ptr(skb);
  198. data += sizeof(struct rmnet_map_header);
  199. return (struct rmnet_map_control_command *)data;
  200. }
  201. static inline u8 rmnet_map_get_next_hdr_type(struct sk_buff *skb)
  202. {
  203. unsigned char *data = rmnet_map_data_ptr(skb);
  204. data += sizeof(struct rmnet_map_header);
  205. return ((struct rmnet_map_v5_coal_header *)data)->header_type;
  206. }
  207. static inline bool rmnet_map_get_csum_valid(struct sk_buff *skb)
  208. {
  209. unsigned char *data = rmnet_map_data_ptr(skb);
  210. data += sizeof(struct rmnet_map_header);
  211. return ((struct rmnet_map_v5_csum_header *)data)->csum_valid_required;
  212. }
  213. struct sk_buff *rmnet_map_deaggregate(struct sk_buff *skb,
  214. struct rmnet_port *port);
  215. struct rmnet_map_header *rmnet_map_add_map_header(struct sk_buff *skb,
  216. int hdrlen, int pad,
  217. struct rmnet_port *port);
  218. void rmnet_map_command(struct sk_buff *skb, struct rmnet_port *port);
  219. int rmnet_map_checksum_downlink_packet(struct sk_buff *skb, u16 len);
  220. void rmnet_map_checksum_uplink_packet(struct sk_buff *skb,
  221. struct rmnet_port *port,
  222. struct net_device *orig_dev,
  223. int csum_type);
  224. bool rmnet_map_v5_csum_buggy(struct rmnet_map_v5_coal_header *coal_hdr);
  225. int rmnet_map_process_next_hdr_packet(struct sk_buff *skb,
  226. struct sk_buff_head *list,
  227. u16 len);
  228. int rmnet_map_tx_agg_skip(struct sk_buff *skb, int offset);
  229. void rmnet_map_tx_aggregate(struct sk_buff *skb, struct rmnet_port *port);
  230. void rmnet_map_tx_aggregate_init(struct rmnet_port *port);
  231. void rmnet_map_tx_aggregate_exit(struct rmnet_port *port);
  232. void rmnet_map_update_ul_agg_config(struct rmnet_port *port, u16 size,
  233. u8 count, u8 features, u32 time);
  234. void rmnet_map_dl_hdr_notify_v2(struct rmnet_port *port,
  235. struct rmnet_map_dl_ind_hdr *dl_hdr,
  236. struct rmnet_map_control_command_header *qcmd);
  237. void rmnet_map_dl_trl_notify_v2(struct rmnet_port *port,
  238. struct rmnet_map_dl_ind_trl *dltrl,
  239. struct rmnet_map_control_command_header *qcmd);
  240. int rmnet_map_flow_command(struct sk_buff *skb,
  241. struct rmnet_port *port,
  242. bool rmnet_perf);
  243. void rmnet_map_cmd_init(struct rmnet_port *port);
  244. int rmnet_map_dl_ind_register(struct rmnet_port *port,
  245. struct rmnet_map_dl_ind *dl_ind);
  246. int rmnet_map_dl_ind_deregister(struct rmnet_port *port,
  247. struct rmnet_map_dl_ind *dl_ind);
  248. void rmnet_map_cmd_exit(struct rmnet_port *port);
  249. #endif /* _RMNET_MAP_H_ */