Re: [PATCH v5 1/4] drm/bridge: Add a drm_bridge_state object

On Mon, Jan 06, 2020 at 11:03:54AM +0100, Boris Brezillon wrote:

On Thu, 19 Dec 2019 11:11:48 +0100 Neil Armstrong wrote:

...

+/**

• • drm_atomic_helper_duplicate_bridge_state() - Default duplicate state helper
• • @bridge: bridge containing the state to duplicate
• • Default implementation of &drm_bridge_funcs.atomic_duplicate().
• • RETURNS:
• • a valid state object or NULL if the allocation fails.
• */

+struct drm_bridge_state * +drm_atomic_helper_bridge_duplicate_state(struct drm_bridge *bridge) +{

• struct drm_bridge_state *new;
• if (WARN_ON(!bridge->base.state))

• return NULL;
  

• new = kzalloc(sizeof(*new), GFP_KERNEL);
• if (new)

• __drm_atomic_helper_bridge_duplicate_state(bridge, new);
  

• return new;

+} +EXPORT_SYMBOL(drm_atomic_helper_bridge_duplicate_state);

IIRC, Laurent suggested to make those functions private. I'd also recommend changing the names to drm_atomic_*default*_bridge_<action>_state() and dropping the kernel doc header since making them static means they're no longer helper functions.

Please note that static functions may still benefit from documentation. In this specific case the documentation can probably be dropped, but if other functions have useful comments, please keep them.