tree 4b1b175dd41bfede94a453069457beee4516dd34
parent af29a884459ef8c01b80e48305ab85121925f874
author Andrew Jeffery <andrew@aj.id.au> 1561689518 +0930
committer Joel Stanley <joel@jms.id.au> 1562043855 +0930

pinctrl: aspeed: Add implementation-related documentation

The ASPEED pinctrl driver implementations make heavy use of macros to
minimise tedium of implementation and maximise the chance that the
compiler will catch errors in defining signal and pin configurations.
While the goal of minimising errors is achieved, it is at the cost of
the complexity of the macros.

Document examples of the expanded form of pin declarations to
demonstrate the operation of the macros.

OpenBMC-Staging-Count: 1
Cc: Johnny Huang <johnny_huang@aspeedtech.com>
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Signed-off-by: Joel Stanley <joel@jms.id.au>