Geekly Articles each Day

コードをクリーンにする：NAND DenaliコントローラーのPCIドライバーリファクタリング

例としてNAND DenaliコントローラーのPCIドライバーを使用して、比較的新しいバージョンのLinuxカーネルで使用可能なマクロとヘルパー関数を使用する場合のコードの簡略化方法を示します。

この古いドライバーはほとんど使用されませんが、リファクタリングできるコードの良い例です。 ドライバー自体は、 drivers / mtd / nand / denali_pci.cにあります。

Kconfigの準備


まず、Kconfigに触れてみましょう。 ドライバーは、すでに古典的なスキーム、つまり主要部分+バス上のドライバー（ロジック（ Torvalds自体を含む））に従って分割されているため、主要部分の選択をユーザーから隠す必要があります。 途中で、変更する行のスペースをタブに置き換えます。

一度やってください！

マクロを適用する


次のステップは、 module_pci_driver()マクロを使用することです。

 --- a/drivers/mtd/nand/denali_pci.c +++ b/drivers/mtd/nand/denali_pci.c @@ -129,14 +129,4 @@ static struct pci_driver denali_pci_driver = { .remove = denali_pci_remove, }; -static int denali_init_pci(void) -{ - return pci_register_driver(&denali_pci_driver); -} -module_init(denali_init_pci); - -static void denali_exit_pci(void) -{ - pci_unregister_driver(&denali_pci_driver); -} -module_exit(denali_exit_pci); +module_pci_driver(denali_pci_driver);


二回やる！

マネージリソースAPIへの移行


次に、最も興味深いことに目を向け、呼び出しをマネージリソースに置き換えます（ ここでそれらを説明しました）。

簡単なdevm_kzalloc()から始めましょう。

何が起こったのか見て
 --- a/drivers/mtd/nand/denali_pci.c +++ b/drivers/mtd/nand/denali_pci.c @@ -35,14 +35,14 @@ static int denali_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) unsigned long csr_len, mem_len; struct denali_nand_info *denali; - denali = kzalloc(sizeof(*denali), GFP_KERNEL); + denali = devm_kzalloc(&dev->dev, sizeof(*denali), GFP_KERNEL); if (!denali) return -ENOMEM; ret = pci_enable_device(dev); if (ret) { pr_err("Spectra: pci_enable_device failed.\n"); - goto failed_alloc_memery; + return ret; } if (id->driver_data == INTEL_CE4100) { @@ -103,9 +103,6 @@ failed_req_regions: pci_release_regions(dev); failed_enable_dev: pci_disable_device(dev); -failed_alloc_memery: - kfree(denali); - return ret; } @@ -119,7 +116,6 @@ static void denali_pci_remove(struct pci_dev *dev) iounmap(denali->flash_mem); pci_release_regions(dev); pci_disable_device(dev); - kfree(denali); }



デバイスはPCIバスに接続されているため、PCIデバイスにはdevres APIを使用します。

何が起こったのか見て
 --- a/drivers/mtd/nand/denali_pci.c +++ b/drivers/mtd/nand/denali_pci.c @@ -30,7 +30,7 @@ MODULE_DEVICE_TABLE(pci, denali_pci_ids); static int denali_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) { - int ret = -ENODEV; + int ret; resource_size_t csr_base, mem_base; unsigned long csr_len, mem_len; struct denali_nand_info *denali; @@ -39,7 +39,7 @@ static int denali_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) if (!denali) return -ENOMEM; - ret = pci_enable_device(dev); + ret = pcim_enable_device(dev); if (ret) { pr_err("Spectra: pci_enable_device failed.\n"); return ret; @@ -70,14 +70,13 @@ static int denali_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) ret = pci_request_regions(dev, DENALI_NAND_NAME); if (ret) { pr_err("Spectra: Unable to request memory regions\n"); - goto failed_enable_dev; + return ret; } denali->flash_reg = ioremap_nocache(csr_base, csr_len); if (!denali->flash_reg) { pr_err("Spectra: Unable to remap memory region\n"); - ret = -ENOMEM; - goto failed_req_regions; + return -ENOMEM; } denali->flash_mem = ioremap_nocache(mem_base, mem_len); @@ -99,10 +98,6 @@ failed_remap_mem: iounmap(denali->flash_mem); failed_remap_reg: iounmap(denali->flash_reg); -failed_req_regions: - pci_release_regions(dev); -failed_enable_dev: - pci_disable_device(dev); return ret; } @@ -114,8 +109,6 @@ static void denali_pci_remove(struct pci_dev *dev) denali_remove(denali); iounmap(denali->flash_reg); iounmap(denali->flash_mem); - pci_release_regions(dev); - pci_disable_device(dev); }


残念ながら、 ioremap_nocache()を取り除くことはできません。対応するPCI BARに保存されている情報を確認するための適切なデバイスが手元にありません（そして、今日これが世界に存在するかどうかはまったくioremap_nocache()ません）。

この章で得たものを組み合わせて、 3つ行います！

追加のリファクタリング


完全な美しさを復元するには、 pr_err()をdev_err()に置き換えpr_err() 。
 --- a/drivers/mtd/nand/denali_pci.c +++ b/drivers/mtd/nand/denali_pci.c @@ -41,7 +41,7 @@ static int denali_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) ret = pcim_enable_device(dev); if (ret) { - pr_err("Spectra: pci_enable_device failed.\n"); + dev_err(&dev->dev, "Spectra: pci_enable_device failed.\n"); return ret; } @@ -69,19 +69,19 @@ static int denali_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) ret = pci_request_regions(dev, DENALI_NAND_NAME); if (ret) { - pr_err("Spectra: Unable to request memory regions\n"); + dev_err(&dev->dev, "Spectra: Unable to request memory regions\n"); return ret; } denali->flash_reg = ioremap_nocache(csr_base, csr_len); if (!denali->flash_reg) { - pr_err("Spectra: Unable to remap memory region\n"); + dev_err(&dev->dev, "Spectra: Unable to remap memory region\n"); return -ENOMEM; } denali->flash_mem = ioremap_nocache(mem_base, mem_len); if (!denali->flash_mem) { - pr_err("Spectra: ioremap_nocache failed!"); + dev_err(&dev->dev, "Spectra: ioremap_nocache failed!"); ret = -ENOMEM; goto failed_remap_reg; }


４つやって！

要約すると：

  drivers/mtd/nand/Kconfig | 13 +++++-------- drivers/mtd/nand/denali_pci.c | 43 +++++++++++-------------------------------- 2 files changed, 16 insertions(+), 40 deletions(-)


明らかな利点。 新しいコードで利用可能なAPIを使用することを忘れないでください！

更新
4つはすべてメンテナーツリーに既にあります 。 コミットID：af83a67cad14、add243d5bc37、2445d33d8523、04868a67ed58。

Source: https://habr.com/ru/post/J264289/

More articles:


All Articles