Re: [PATCH 1/2] mmc: tmio: rename files and CONFIG options to have the same prefix

[Ulf Hansson]

On 31 July 2018 at 14:12, Masahiro Yamada <yamada.masahiro@xxxxxxxxxxxxx> wrote:
> 2018-07-31 0:07 GMT+09:00 Ulf Hansson <ulf.hansson@xxxxxxxxxx>:
>> On 26 July 2018 at 05:28, Masahiro Yamada <yamada.masahiro@xxxxxxxxxxxxx> wrote:
>>> As commit b6147490e6aa ("mmc: tmio: split core functionality, DMA and
>>> MFD glue") said, these MMC controllers use the IP from Panasonic.
>>>
>>> TMIO (Toshiba Mobile IO) MMC was the first upstreamed user of this IP.
>>> The common driver code was split and expanded as 'tmio-mmc-core', then
>>> it become historical misnomer since 'tmio' is not the name of this IP.
>>>
>>> I pointed out this [1], and suggested to re-organize the names in the
>>> form of:
>>>
>>>   <IP-name>.c            (common code for this IP)
>>>   <IP-name>_tmio.c       (Toshiba Mobile IO)
>>>   <IP-name>_sdhi.c       (Renesas SDHI)
>>>   <IP-name>_uniphier.c   (Socionext UniPhier)
>>>
>>> The <IP-name> in my mind was 'mnsd' because names of Panasonic chips
>>> are prefixed with 'MN'.
>>>
>>> This is the naming scheme as we see in dw_mmc* and sdhci-*.
>>>
>>> In the discussion with Wolfram Sang, my suggestion was rejected
>>> because it implied drastic function renaming, which is too invasive.
>>>
>>> Ulf Hansson was still happy with file renaming to clarify the
>>> relationship between variants.  So, the accepted solution was:
>>>
>>>  - Make 'tmio_mmc' the _right_ core name
>>>  - Align all variant files with the same prefix.
>>>  - Do not rename functions
>>>
>>> This commit renames files as follows:
>>>
>>>   tmio_mmc_core.c              -> tmio_mmc.c
>>>   tmio_mmc.c                   -> tmio_mmc_original.c
>>>   renesas_sdhi_core.c          -> tmio_mmc_sdhi.c
>>>   renesas_sdhi.h               -> tmio_mmc_sdhi.h
>>>   renesas_sdhi_internal_dmac.c -> tmio_mmc_sdhi_internal_dmac.c
>>>   renesas_sdhi_sys_dmac.c      -> tmio_mmc_sdhi_sys_dmac.c
>>>
>>> Also rename CONFIG options to match to the file names:
>>>
>>>   MMC_TMIO_CORE          -> MMC_TMIO
>>>   MMC_TMIO               -> MMC_TMIO_ORIGINAL
>>>   MMC_SDHI               -> MMC_TMIO_SDHI
>>>   MMC_SDHI_SYS_DMAC      -> MMC_TMIO_SDHI_SYS_DMAC
>>>   MMC_SDHI_INTERNAL_DMAC -> MMC_TMIO_SDHI_INTERNAL_DMAC
>>>
>>> I touched eseries_pxa_defconfig and pxa_defconfig in this commit
>>> because they are inactive, but renaming of CONFIG options generally
>>> takes some development cycles.  Old names will be kept until the
>>> migration is completed, like Renesas folks did when they renamed
>>> ARCH_SHMOBILE_MULTI to ARCH_RENESAS.
>>>
>>> [1] https://www.spinics.net/lists/linux-mmc/msg46952.html
>>>
>>> Signed-off-by: Masahiro Yamada <yamada.masahiro@xxxxxxxxxxxxx>
>>
>> I am awaiting some feedback from Wolfram before applying.
>
>
>
> If this is not welcome, please feel free to throw away.
> (then, I will name my driver 'uniphier-sd.c')
>
> I am neutral about this renaming because it
> is trying to make the wrong thing correct.
>
>
> It will also produce a different inconsistency.
> Even if we rename renesas_sdhi_core.c to tmio_mmc_sdhi.c ,
> functions in it will be kept renesas_sdhi_*
> I understand they want to keep the file name and function names consistent.

Yes, we have discussed this, back an forth.

I have no strong opinions, but instead rely on you reaching an
agreement with Wolfram on the way forward.

[...]

Kind regards
Uffe