From patchwork Wed Dec 16 17:16:46 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 7864031 Return-Path: X-Original-To: patchwork-linux-media@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 9D6B29F350 for ; Wed, 16 Dec 2015 17:17:12 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id D5C09202F8 for ; Wed, 16 Dec 2015 17:17:11 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id D88A72025B for ; Wed, 16 Dec 2015 17:17:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S965967AbbLPRRH (ORCPT ); Wed, 16 Dec 2015 12:17:07 -0500 Received: from bombadil.infradead.org ([198.137.202.9]:44011 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S965804AbbLPRRH (ORCPT ); Wed, 16 Dec 2015 12:17:07 -0500 Received: from [191.33.142.179] (helo=smtp.w2.samsung.com) by bombadil.infradead.org with esmtpsa (Exim 4.80.1 #2 (Red Hat Linux)) id 1a9FhK-0001Cz-DS; Wed, 16 Dec 2015 17:17:06 +0000 Received: from mchehab by smtp.w2.samsung.com with local (Exim 4.86) (envelope-from ) id 1a9Fh1-00077Y-Tk; Wed, 16 Dec 2015 15:16:47 -0200 From: Mauro Carvalho Chehab Cc: Mauro Carvalho Chehab , Linux Media Mailing List , Mauro Carvalho Chehab Subject: [PATCH] [media] media-entity.h: document the remaining functions Date: Wed, 16 Dec 2015 15:16:46 -0200 Message-Id: <55b894723556a7e45891ed0800e835af32f71d16.1450286204.git.mchehab@osg.samsung.com> X-Mailer: git-send-email 2.5.0 To: unlisted-recipients:; (no To-header on input) Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP There are two ancillary functions that are missing comments. While those are used only internally at media-entity.c, document them, for completeness. Signed-off-by: Mauro Carvalho Chehab --- include/media/media-entity.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/include/media/media-entity.h b/include/media/media-entity.h index 73ab2bc6a1c9..db874439dcd6 100644 --- a/include/media/media-entity.h +++ b/include/media/media-entity.h @@ -301,11 +301,22 @@ static inline enum media_gobj_type media_type(struct media_gobj *gobj) return gobj->id >> MEDIA_BITS_PER_ID; } +/** + * media_id() - return the media object ID + * + * @gobj: pointer to the media graph object + */ static inline u64 media_id(struct media_gobj *gobj) { return gobj->id & MEDIA_ID_MASK; } +/** + * media_gobj_gen_id() - encapsulates type and ID on at the object ID + * + * @type: object type as define at enum &media_gobj_type. + * @local_id: next ID, from struct &media_device.@id. + */ static inline u64 media_gobj_gen_id(enum media_gobj_type type, u64 local_id) { u64 id;