GNU Linux-libre 5.10.153-gnu1
[releases.git] / drivers / staging / qlge / TODO
1 * commit 7c734359d350 ("qlge: Size RX buffers based on MTU.", v2.6.33-rc1)
2   introduced dead code in the receive routines, which should be rewritten
3   anyways by the admission of the author himself, see the comment above
4   ql_build_rx_skb(). That function is now used exclusively to handle packets
5   that underwent header splitting but it still contains code to handle non
6   split cases.
7 * truesize accounting is incorrect (ex: a 9000B frame has skb->truesize 10280
8   while containing two frags of order-1 allocations, ie. >16K)
9 * while in that area, using two 8k buffers to store one 9k frame is a poor
10   choice of buffer size.
11 * in the "chain of large buffers" case, the driver uses an skb allocated with
12   head room but only puts data in the frags.
13 * rename "rx" queues to "completion" queues. Calling tx completion queues "rx
14   queues" is confusing.
15 * struct rx_ring is used for rx and tx completions, with some members relevant
16   to one case only
17 * there is an inordinate amount of disparate debugging code, most of which is
18   of questionable value. In particular, qlge_dbg.c has hundreds of lines of
19   code bitrotting away in ifdef land (doesn't compile since commit
20   18c49b91777c ("qlge: do vlan cleanup", v3.1-rc1), 8 years ago).
21 * triggering an ethtool regdump will hexdump a 176k struct to dmesg depending
22   on some module parameters.
23 * the flow control implementation in firmware is buggy (sends a flood of pause
24   frames, resets the link, device and driver buffer queues become
25   desynchronized), disable it by default
26 * some structures are initialized redundantly (ex. memset 0 after
27   alloc_etherdev())
28 * the driver has a habit of using runtime checks where compile time checks are
29   possible (ex. ql_free_rx_buffers(), ql_alloc_rx_buffers())
30 * reorder struct members to avoid holes if it doesn't impact performance
31 * in terms of namespace, the driver uses either qlge_, ql_ (used by
32   other qlogic drivers, with clashes, ex: ql_sem_spinlock) or nothing (with
33   clashes, ex: struct ob_mac_iocb_req). Rename everything to use the "qlge_"
34   prefix.
35 * avoid legacy/deprecated apis (ex. replace pci_dma_*, replace pci_enable_msi,
36   use pci_iomap)
37 * some "while" loops could be rewritten with simple "for", ex.
38   ql_wait_reg_rdy(), ql_start_rx_ring())
39 * remove duplicate and useless comments
40 * fix weird line wrapping (all over, ex. the ql_set_routing_reg() calls in
41   qlge_set_multicast_list()).
42 * fix weird indentation (all over, ex. the for loops in qlge_get_stats())
43 * fix checkpatch issues