dsa-uclass.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Copyright 2019-2021 NXP
  4. */
  5. #include <net/dsa.h>
  6. #include <dm/lists.h>
  7. #include <dm/device_compat.h>
  8. #include <dm/device-internal.h>
  9. #include <dm/uclass-internal.h>
  10. #include <linux/bitmap.h>
  11. #include <miiphy.h>
  12. #define DSA_PORT_CHILD_DRV_NAME "dsa-port"
  13. /* per-device internal state structure */
  14. struct dsa_priv {
  15. struct phy_device *cpu_port_fixed_phy;
  16. struct udevice *master_dev;
  17. int num_ports;
  18. u32 cpu_port;
  19. int headroom;
  20. int tailroom;
  21. };
  22. /* external API */
  23. int dsa_set_tagging(struct udevice *dev, ushort headroom, ushort tailroom)
  24. {
  25. struct dsa_priv *priv;
  26. if (!dev)
  27. return -EINVAL;
  28. if (headroom + tailroom > DSA_MAX_OVR)
  29. return -EINVAL;
  30. priv = dev_get_uclass_priv(dev);
  31. if (headroom > 0)
  32. priv->headroom = headroom;
  33. if (tailroom > 0)
  34. priv->tailroom = tailroom;
  35. return 0;
  36. }
  37. /* returns the DSA master Ethernet device */
  38. struct udevice *dsa_get_master(struct udevice *dev)
  39. {
  40. struct dsa_priv *priv;
  41. if (!dev)
  42. return NULL;
  43. priv = dev_get_uclass_priv(dev);
  44. return priv->master_dev;
  45. }
  46. /*
  47. * Start the desired port, the CPU port and the master Eth interface.
  48. * TODO: if cascaded we may need to _start ports in other switches too
  49. */
  50. static int dsa_port_start(struct udevice *pdev)
  51. {
  52. struct udevice *dev = dev_get_parent(pdev);
  53. struct dsa_priv *priv = dev_get_uclass_priv(dev);
  54. struct udevice *master = dsa_get_master(dev);
  55. struct dsa_ops *ops = dsa_get_ops(dev);
  56. int err;
  57. if (ops->port_enable) {
  58. struct dsa_port_pdata *port_pdata;
  59. port_pdata = dev_get_parent_plat(pdev);
  60. err = ops->port_enable(dev, port_pdata->index,
  61. port_pdata->phy);
  62. if (err)
  63. return err;
  64. err = ops->port_enable(dev, priv->cpu_port,
  65. priv->cpu_port_fixed_phy);
  66. if (err)
  67. return err;
  68. }
  69. return eth_get_ops(master)->start(master);
  70. }
  71. /* Stop the desired port, the CPU port and the master Eth interface */
  72. static void dsa_port_stop(struct udevice *pdev)
  73. {
  74. struct udevice *dev = dev_get_parent(pdev);
  75. struct dsa_priv *priv = dev_get_uclass_priv(dev);
  76. struct udevice *master = dsa_get_master(dev);
  77. struct dsa_ops *ops = dsa_get_ops(dev);
  78. if (ops->port_disable) {
  79. struct dsa_port_pdata *port_pdata;
  80. port_pdata = dev_get_parent_plat(pdev);
  81. ops->port_disable(dev, port_pdata->index, port_pdata->phy);
  82. ops->port_disable(dev, priv->cpu_port, NULL);
  83. }
  84. eth_get_ops(master)->stop(master);
  85. }
  86. /*
  87. * Insert a DSA tag and call master Ethernet send on the resulting packet
  88. * We copy the frame to a stack buffer where we have reserved headroom and
  89. * tailroom space. Headroom and tailroom are set to 0.
  90. */
  91. static int dsa_port_send(struct udevice *pdev, void *packet, int length)
  92. {
  93. struct udevice *dev = dev_get_parent(pdev);
  94. struct dsa_priv *priv = dev_get_uclass_priv(dev);
  95. int head = priv->headroom, tail = priv->tailroom;
  96. struct udevice *master = dsa_get_master(dev);
  97. struct dsa_ops *ops = dsa_get_ops(dev);
  98. uchar dsa_packet_tmp[PKTSIZE_ALIGN];
  99. struct dsa_port_pdata *port_pdata;
  100. int err;
  101. if (length + head + tail > PKTSIZE_ALIGN)
  102. return -EINVAL;
  103. memset(dsa_packet_tmp, 0, head);
  104. memset(dsa_packet_tmp + head + length, 0, tail);
  105. memcpy(dsa_packet_tmp + head, packet, length);
  106. length += head + tail;
  107. /* copy back to preserve original buffer alignment */
  108. memcpy(packet, dsa_packet_tmp, length);
  109. port_pdata = dev_get_parent_plat(pdev);
  110. err = ops->xmit(dev, port_pdata->index, packet, length);
  111. if (err)
  112. return err;
  113. return eth_get_ops(master)->send(master, packet, length);
  114. }
  115. /* Receive a frame from master Ethernet, process it and pass it on */
  116. static int dsa_port_recv(struct udevice *pdev, int flags, uchar **packetp)
  117. {
  118. struct udevice *dev = dev_get_parent(pdev);
  119. struct dsa_priv *priv = dev_get_uclass_priv(dev);
  120. int head = priv->headroom, tail = priv->tailroom;
  121. struct udevice *master = dsa_get_master(dev);
  122. struct dsa_ops *ops = dsa_get_ops(dev);
  123. struct dsa_port_pdata *port_pdata;
  124. int length, port_index, err;
  125. length = eth_get_ops(master)->recv(master, flags, packetp);
  126. if (length <= 0)
  127. return length;
  128. /*
  129. * If we receive frames from a different port or frames that DSA driver
  130. * doesn't like we discard them here.
  131. * In case of discard we return with no frame and expect to be called
  132. * again instead of looping here, so upper layer can deal with timeouts.
  133. */
  134. port_pdata = dev_get_parent_plat(pdev);
  135. err = ops->rcv(dev, &port_index, *packetp, length);
  136. if (err || port_index != port_pdata->index || (length <= head + tail)) {
  137. if (eth_get_ops(master)->free_pkt)
  138. eth_get_ops(master)->free_pkt(master, *packetp, length);
  139. return -EAGAIN;
  140. }
  141. /*
  142. * We move the pointer over headroom here to avoid a copy. If free_pkt
  143. * gets called we move the pointer back before calling master free_pkt.
  144. */
  145. *packetp += head;
  146. return length - head - tail;
  147. }
  148. static int dsa_port_free_pkt(struct udevice *pdev, uchar *packet, int length)
  149. {
  150. struct udevice *dev = dev_get_parent(pdev);
  151. struct udevice *master = dsa_get_master(dev);
  152. struct dsa_priv *priv;
  153. priv = dev_get_uclass_priv(dev);
  154. if (eth_get_ops(master)->free_pkt) {
  155. /* return the original pointer and length to master Eth */
  156. packet -= priv->headroom;
  157. length += priv->headroom - priv->tailroom;
  158. return eth_get_ops(master)->free_pkt(master, packet, length);
  159. }
  160. return 0;
  161. }
  162. static int dsa_port_of_to_pdata(struct udevice *pdev)
  163. {
  164. struct dsa_port_pdata *port_pdata;
  165. struct dsa_pdata *dsa_pdata;
  166. struct eth_pdata *eth_pdata;
  167. struct udevice *dev;
  168. const char *label;
  169. u32 index;
  170. int err;
  171. if (!pdev)
  172. return -ENODEV;
  173. err = ofnode_read_u32(dev_ofnode(pdev), "reg", &index);
  174. if (err)
  175. return err;
  176. dev = dev_get_parent(pdev);
  177. dsa_pdata = dev_get_uclass_plat(dev);
  178. port_pdata = dev_get_parent_plat(pdev);
  179. port_pdata->index = index;
  180. label = ofnode_read_string(dev_ofnode(pdev), "label");
  181. if (label)
  182. strncpy(port_pdata->name, label, DSA_PORT_NAME_LENGTH);
  183. eth_pdata = dev_get_plat(pdev);
  184. eth_pdata->priv_pdata = port_pdata;
  185. dev_dbg(pdev, "port %d node %s\n", port_pdata->index,
  186. ofnode_get_name(dev_ofnode(pdev)));
  187. return 0;
  188. }
  189. static const struct eth_ops dsa_port_ops = {
  190. .start = dsa_port_start,
  191. .send = dsa_port_send,
  192. .recv = dsa_port_recv,
  193. .stop = dsa_port_stop,
  194. .free_pkt = dsa_port_free_pkt,
  195. };
  196. static int dsa_port_probe(struct udevice *pdev)
  197. {
  198. struct udevice *dev = dev_get_parent(pdev);
  199. struct eth_pdata *eth_pdata, *master_pdata;
  200. unsigned char env_enetaddr[ARP_HLEN];
  201. struct dsa_port_pdata *port_pdata;
  202. struct dsa_priv *dsa_priv;
  203. struct udevice *master;
  204. int ret;
  205. port_pdata = dev_get_parent_plat(pdev);
  206. dsa_priv = dev_get_uclass_priv(dev);
  207. port_pdata->phy = dm_eth_phy_connect(pdev);
  208. if (!port_pdata->phy)
  209. return -ENODEV;
  210. master = dsa_get_master(dev);
  211. if (!master)
  212. return -ENODEV;
  213. /*
  214. * Probe the master device. We depend on the master device for proper
  215. * operation and we also need it for MAC inheritance below.
  216. *
  217. * TODO: we assume the master device is always there and doesn't get
  218. * removed during runtime.
  219. */
  220. ret = device_probe(master);
  221. if (ret)
  222. return ret;
  223. /*
  224. * Inherit port's hwaddr from the DSA master, unless the port already
  225. * has a unique MAC address specified in the environment.
  226. */
  227. eth_env_get_enetaddr_by_index("eth", dev_seq(pdev), env_enetaddr);
  228. if (!is_zero_ethaddr(env_enetaddr)) {
  229. /* individual port mac addrs require master to be promisc */
  230. struct eth_ops *eth_ops = eth_get_ops(master);
  231. if (eth_ops->set_promisc)
  232. eth_ops->set_promisc(master, 1);
  233. return 0;
  234. }
  235. master_pdata = dev_get_plat(master);
  236. eth_pdata = dev_get_plat(pdev);
  237. memcpy(eth_pdata->enetaddr, master_pdata->enetaddr, ARP_HLEN);
  238. eth_env_set_enetaddr_by_index("eth", dev_seq(pdev),
  239. master_pdata->enetaddr);
  240. return 0;
  241. }
  242. static int dsa_port_remove(struct udevice *pdev)
  243. {
  244. struct udevice *dev = dev_get_parent(pdev);
  245. struct dsa_port_pdata *port_pdata;
  246. struct dsa_priv *dsa_priv;
  247. port_pdata = dev_get_parent_plat(pdev);
  248. dsa_priv = dev_get_uclass_priv(dev);
  249. port_pdata->phy = NULL;
  250. return 0;
  251. }
  252. U_BOOT_DRIVER(dsa_port) = {
  253. .name = DSA_PORT_CHILD_DRV_NAME,
  254. .id = UCLASS_ETH,
  255. .ops = &dsa_port_ops,
  256. .probe = dsa_port_probe,
  257. .remove = dsa_port_remove,
  258. .of_to_plat = dsa_port_of_to_pdata,
  259. .plat_auto = sizeof(struct eth_pdata),
  260. };
  261. /*
  262. * This function mostly deals with pulling information out of the device tree
  263. * into the pdata structure.
  264. * It goes through the list of switch ports, registers an eth device for each
  265. * front panel port and identifies the cpu port connected to master eth device.
  266. * TODO: support cascaded switches
  267. */
  268. static int dsa_post_bind(struct udevice *dev)
  269. {
  270. struct dsa_pdata *pdata = dev_get_uclass_plat(dev);
  271. ofnode node = dev_ofnode(dev), pnode;
  272. int i, err, first_err = 0;
  273. if (!ofnode_valid(node))
  274. return -ENODEV;
  275. pdata->master_node = ofnode_null();
  276. node = ofnode_find_subnode(node, "ports");
  277. if (!ofnode_valid(node))
  278. node = ofnode_find_subnode(node, "ethernet-ports");
  279. if (!ofnode_valid(node)) {
  280. dev_err(dev, "ports node is missing under DSA device!\n");
  281. return -EINVAL;
  282. }
  283. pdata->num_ports = ofnode_get_child_count(node);
  284. if (pdata->num_ports <= 0 || pdata->num_ports > DSA_MAX_PORTS) {
  285. dev_err(dev, "invalid number of ports (%d)\n",
  286. pdata->num_ports);
  287. return -EINVAL;
  288. }
  289. /* look for the CPU port */
  290. ofnode_for_each_subnode(pnode, node) {
  291. u32 ethernet;
  292. if (ofnode_read_u32(pnode, "ethernet", &ethernet))
  293. continue;
  294. pdata->master_node = ofnode_get_by_phandle(ethernet);
  295. pdata->cpu_port_node = pnode;
  296. break;
  297. }
  298. if (!ofnode_valid(pdata->master_node)) {
  299. dev_err(dev, "master eth node missing!\n");
  300. return -EINVAL;
  301. }
  302. if (ofnode_read_u32(pnode, "reg", &pdata->cpu_port)) {
  303. dev_err(dev, "CPU port node not valid!\n");
  304. return -EINVAL;
  305. }
  306. dev_dbg(dev, "master node %s on port %d\n",
  307. ofnode_get_name(pdata->master_node), pdata->cpu_port);
  308. for (i = 0; i < pdata->num_ports; i++) {
  309. char name[DSA_PORT_NAME_LENGTH];
  310. struct udevice *pdev;
  311. /*
  312. * If this is the CPU port don't register it as an ETH device,
  313. * we skip it on purpose since I/O to/from it from the CPU
  314. * isn't useful.
  315. */
  316. if (i == pdata->cpu_port)
  317. continue;
  318. /*
  319. * Set up default port names. If present, DT port labels
  320. * will override the default port names.
  321. */
  322. snprintf(name, DSA_PORT_NAME_LENGTH, "%s@%d", dev->name, i);
  323. ofnode_for_each_subnode(pnode, node) {
  324. u32 reg;
  325. if (ofnode_read_u32(pnode, "reg", &reg))
  326. continue;
  327. if (reg == i)
  328. break;
  329. }
  330. /*
  331. * skip registration if port id not found or if the port
  332. * is explicitly disabled in DT
  333. */
  334. if (!ofnode_valid(pnode) || !ofnode_is_available(pnode))
  335. continue;
  336. err = device_bind_driver_to_node(dev, DSA_PORT_CHILD_DRV_NAME,
  337. name, pnode, &pdev);
  338. if (pdev) {
  339. struct dsa_port_pdata *port_pdata;
  340. port_pdata = dev_get_parent_plat(pdev);
  341. strncpy(port_pdata->name, name, DSA_PORT_NAME_LENGTH);
  342. pdev->name = port_pdata->name;
  343. }
  344. /* try to bind all ports but keep 1st error */
  345. if (err && !first_err)
  346. first_err = err;
  347. }
  348. if (first_err)
  349. return first_err;
  350. dev_dbg(dev, "DSA ports successfully bound\n");
  351. return 0;
  352. }
  353. /**
  354. * Initialize the uclass per device internal state structure (priv).
  355. * TODO: pick up references to other switch devices here, if we're cascaded.
  356. */
  357. static int dsa_pre_probe(struct udevice *dev)
  358. {
  359. struct dsa_pdata *pdata = dev_get_uclass_plat(dev);
  360. struct dsa_priv *priv = dev_get_uclass_priv(dev);
  361. priv->num_ports = pdata->num_ports;
  362. priv->cpu_port = pdata->cpu_port;
  363. priv->cpu_port_fixed_phy = fixed_phy_create(pdata->cpu_port_node);
  364. if (!priv->cpu_port_fixed_phy) {
  365. dev_err(dev, "Failed to register fixed-link for CPU port\n");
  366. return -ENODEV;
  367. }
  368. uclass_find_device_by_ofnode(UCLASS_ETH, pdata->master_node,
  369. &priv->master_dev);
  370. return 0;
  371. }
  372. UCLASS_DRIVER(dsa) = {
  373. .id = UCLASS_DSA,
  374. .name = "dsa",
  375. .post_bind = dsa_post_bind,
  376. .pre_probe = dsa_pre_probe,
  377. .per_device_auto = sizeof(struct dsa_priv),
  378. .per_device_plat_auto = sizeof(struct dsa_pdata),
  379. .per_child_plat_auto = sizeof(struct dsa_port_pdata),
  380. .flags = DM_UC_FLAG_SEQ_ALIAS,
  381. };