From patchwork Wed Dec 22 17:11:12 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Anderson X-Patchwork-Id: 1572253 X-Patchwork-Delegate: seanga2@gmail.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: bilbo.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20210112 header.b=PqDQSR7G; dkim-atps=neutral Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=85.214.62.61; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by bilbo.ozlabs.org (Postfix) with ESMTPS id 4JK0Hp3Q6lz9t1C for ; Thu, 23 Dec 2021 04:12:21 +1100 (AEDT) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 02D1B833C3; Wed, 22 Dec 2021 18:11:53 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="PqDQSR7G"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 026D78304D; Wed, 22 Dec 2021 18:11:46 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_ENVFROM_END_DIGIT, FREEMAIL_FROM,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.2 Received: from mail-qv1-xf2c.google.com (mail-qv1-xf2c.google.com [IPv6:2607:f8b0:4864:20::f2c]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 4E7908342C for ; Wed, 22 Dec 2021 18:11:32 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=seanga2@gmail.com Received: by mail-qv1-xf2c.google.com with SMTP id q3so2880984qvc.7 for ; Wed, 22 Dec 2021 09:11:32 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Siq+MMi69a82vg4oScs1X0glWz2gEaWKVHwC+k5jrlU=; b=PqDQSR7GO9Ank5vftG+8Iawc2RSloNuvRiE0wkv4FejxLxbxyKesEy305Wv/FgeqKB c0S656YlSD7yO2PvyO2PJMZHPErqwL4JBM5PcPqDQP7eW1E4uO3It3FqFU61moulo7Kx Ergt4ymoVyb3gNqBZrZhObVCa0RfyrBrIIOZjYfQwUEI7MQBaR3qG8u7yjO610rbn5cR A1QIv/C3HAODm4PBCMImqHKLtGzSBEDvIesWBtNZluvRnl8VP+1HDwn72sBQAWo+zgA1 DksZ3AAkkfvZoJYGWX8ORyrx9nKSF0tXKZE566QzB8Lcq8ycHE5/WA3q46OZeTNBaClM dEZw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Siq+MMi69a82vg4oScs1X0glWz2gEaWKVHwC+k5jrlU=; b=qB7g+hgVW9KaWNm5n0pfpzlJvqpxT3D3o1P4k4MgPmPjCb68HpGT2RKR8yWAnk1j0j ECEyCW5Jdla5FgkpyUMXvEq2uyoOYF2Fq9Fk8tOyNqSaxNvmHGXIGWRRAncEPXY7H/E/ 0DiKs6FdZlc7uBXHogXDTOayLyQ1qKBbo4ddT+NrWD24amtJt6W9SQ2mlj5027hvhJKf h2CZyKKh6mbPMdzrvhv7SQKQ+dptjZFXc5DGksLyYCIGELypDO+8VzoLJkEZew9YSMkX KqahGA5bNqKHfdOrk4R1F12P6e3L80oZkVm7A6N6DxLyNMADtNeMdTw6PU91U7ZPXs1t HQCg== X-Gm-Message-State: AOAM5329S5SgKaVCzrOraGuXgSOSExC5M+QpkCB3wPj4+0FCwFYll/zB HIDkYnqPGHIrbHG45eXfA+08q2FdoME= X-Google-Smtp-Source: ABdhPJy9GdmOVtkdldyCP3sh5upkwKG2QT4kmIz4aRk0l9NguNszJ1PxEdiA1KZDhGFe4fgYmFyltA== X-Received: by 2002:a05:6214:27cd:: with SMTP id ge13mr3325446qvb.66.1640193090146; Wed, 22 Dec 2021 09:11:30 -0800 (PST) Received: from godwin.fios-router.home (pool-108-18-207-184.washdc.fios.verizon.net. [108.18.207.184]) by smtp.gmail.com with ESMTPSA id j21sm2099609qkk.27.2021.12.22.09.11.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Dec 2021 09:11:29 -0800 (PST) From: Sean Anderson To: u-boot@lists.denx.de Cc: Simon Glass , Lukasz Majewski , Dario Binacchi , Sean Anderson , Heinrich Schuchardt Subject: [PATCH v2 3/5] clk: Add client API to HTML docs Date: Wed, 22 Dec 2021 12:11:12 -0500 Message-Id: <20211222171114.3091780-4-seanga2@gmail.com> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20211222171114.3091780-1-seanga2@gmail.com> References: <20211222171114.3091780-1-seanga2@gmail.com> MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.38 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.2 at phobos.denx.de X-Virus-Status: Clean This converts the existing client (aka clk.h) documentation to kernel doc format, and adds it to the HTML docs. I have tried to preserve existing comments as much as possible, refraining from semantic changes. Signed-off-by: Sean Anderson Tested-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- (no changes since v1) doc/api/clk.rst | 13 +++ doc/api/index.rst | 1 + include/clk.h | 229 +++++++++++++++++++++++----------------------- 3 files changed, 129 insertions(+), 114 deletions(-) create mode 100644 doc/api/clk.rst diff --git a/doc/api/clk.rst b/doc/api/clk.rst new file mode 100644 index 0000000000..7eb3b5645a --- /dev/null +++ b/doc/api/clk.rst @@ -0,0 +1,13 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Clock API +========= + +.. kernel-doc:: include/clk.h + :doc: Overview + +Client API +---------- + +.. kernel-doc:: include/clk.h + :internal: diff --git a/doc/api/index.rst b/doc/api/index.rst index 806c7385a6..83d4f3e5c1 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -6,6 +6,7 @@ U-Boot API documentation .. toctree:: :maxdepth: 2 + clk dfu efi getopt diff --git a/include/clk.h b/include/clk.h index 82c763d03f..33f448eb89 100644 --- a/include/clk.h +++ b/include/clk.h @@ -14,6 +14,8 @@ #include /** + * DOC: Overview + * * A clock is a hardware signal that oscillates autonomously at a specific * frequency and duty cycle. Most hardware modules require one or more clock * signal to drive their operation. Clock signals are typically generated @@ -34,22 +36,22 @@ struct udevice; /** * struct clk - A handle to (allowing control of) a single clock. - * - * Clients provide storage for clock handles. The content of the structure is - * managed solely by the clock API and clock drivers. A clock struct is - * initialized by "get"ing the clock struct. The clock struct is passed to all - * other clock APIs to identify which clock signal to operate upon. - * * @dev: The device which implements the clock signal. * @rate: The clock rate (in HZ). - * @flags: Flags used across common clock structure (e.g. CLK_) + * @flags: Flags used across common clock structure (e.g. %CLK_) * Clock IP blocks specific flags (i.e. mux, div, gate, etc) are defined - * in struct's for those devices (e.g. struct clk_mux). + * in struct's for those devices (e.g. &struct clk_mux). + * @enable_count: The number of times this clock has been enabled. * @id: The clock signal ID within the provider. * @data: An optional data field for scenarios where a single integer ID is not * sufficient. If used, it can be populated through an .of_xlate op and * processed during the various clock ops. * + * Clients provide storage for clock handles. The content of the structure is + * managed solely by the clock API and clock drivers. A clock struct is + * initialized by "get"ing the clock struct. The clock struct is passed to all + * other clock APIs to identify which clock signal to operate upon. + * * Should additional information to identify and configure any clock signal * for any provider be required in the future, the struct could be expanded to * either (a) add more fields to allow clock providers to store additional @@ -72,15 +74,14 @@ struct clk { /** * struct clk_bulk - A handle to (allowing control of) a bulk of clocks. + * @clks: An array of clock handles. + * @count: The number of clock handles in the clks array. * * Clients provide storage for the clock bulk. The content of the structure is * managed solely by the clock API. A clock bulk struct is * initialized by "get"ing the clock bulk struct. * The clock bulk struct is passed to all other bulk clock APIs to apply * the API to all the clock in the bulk struct. - * - * @clks: An array of clock handles. - * @count: The number of clock handles in the clks array. */ struct clk_bulk { struct clk *clks; @@ -91,16 +92,19 @@ struct clk_bulk { struct phandle_1_arg; /** * clk_get_by_phandle() - Get a clock by its phandle information (of-platadata) + * @dev: Device containing the phandle + * @cells: Phandle info + * @clk: A pointer to a clock struct to initialise * * This function is used when of-platdata is enabled. * * This looks up a clock using the phandle info. With dtoc, each phandle in the - * 'clocks' property is transformed into an idx representing the device. For - * example: + * 'clocks' property is transformed into an idx representing the device. + * For example:: * * clocks = <&dpll_mpu_ck 23>; * - * might result in: + * might result in:: * * .clocks = {1, {23}},}, * @@ -109,16 +113,17 @@ struct phandle_1_arg; * this example it would return a clock containing the 'dpll_mpu_ck' device and * the clock ID 23. * - * @dev: Device containing the phandle - * @cells: Phandle info - * @clock: A pointer to a clock struct to initialise - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells, struct clk *clk); /** * clk_get_by_index() - Get/request a clock by integer index. + * @dev: The client device. + * @index: The index of the clock to request, within the client's list of + * clocks. + * @clk: A pointer to a clock struct to initialize. * * This looks up and requests a clock. The index is relative to the client * device; each device is assumed to have n clocks associated with it somehow, @@ -126,30 +131,28 @@ int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells, * device clock indices to provider clocks may be via device-tree properties, * board-provided mapping tables, or some other mechanism. * - * @dev: The client device. - * @index: The index of the clock to request, within the client's list of - * clocks. - * @clock A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_index(struct udevice *dev, int index, struct clk *clk); /** - * clk_get_by_index_nodev - Get/request a clock by integer index - * without a device. + * clk_get_by_index_nodev() - Get/request a clock by integer index without a + * device. + * @node: The client ofnode. + * @index: The index of the clock to request, within the client's list of + * clocks. + * @clk: A pointer to a clock struct to initialize. * * This is a version of clk_get_by_index() that does not use a device. * - * @node: The client ofnode. - * @index: The index of the clock to request, within the client's list of - * clocks. - * @clock A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk); /** - * clk_get_bulk - Get/request all clocks of a device. + * clk_get_bulk() - Get/request all clocks of a device. + * @dev: The client device. + * @bulk: A pointer to a clock bulk struct to initialize. * * This looks up and requests all clocks of the client device; each device is * assumed to have n clocks associated with it somehow, and this function finds @@ -157,14 +160,16 @@ int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk); * device clock indices to provider clocks may be via device-tree properties, * board-provided mapping tables, or some other mechanism. * - * @dev: The client device. - * @bulk A pointer to a clock bulk struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk); /** - * clk_get_by_name - Get/request a clock by name. + * clk_get_by_name() - Get/request a clock by name. + * @dev: The client device. + * @name: The name of the clock to request, within the client's list of + * clocks. + * @clk: A pointer to a clock struct to initialize. * * This looks up and requests a clock. The name is relative to the client * device; each device is assumed to have n clocks associated with it somehow, @@ -172,55 +177,51 @@ int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk); * device clock names to provider clocks may be via device-tree properties, * board-provided mapping tables, or some other mechanism. * - * @dev: The client device. - * @name: The name of the clock to request, within the client's list of - * clocks. - * @clock: A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk); /** * clk_get_by_name_nodev - Get/request a clock by name without a device. + * @node: The client ofnode. + * @name: The name of the clock to request, within the client's list of + * clocks. + * @clk: A pointer to a clock struct to initialize. * * This is a version of clk_get_by_name() that does not use a device. * - * @node: The client ofnode. - * @name: The name of the clock to request, within the client's list of - * clocks. - * @clock: A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk); /** - * devm_clk_get - lookup and obtain a managed reference to a clock producer. + * devm_clk_get() - lookup and obtain a managed reference to a clock producer. * @dev: device for clock "consumer" * @id: clock consumer ID * - * Returns a struct clk corresponding to the clock producer, or - * valid IS_ERR() condition containing errno. The implementation - * uses @dev and @id to determine the clock consumer, and thereby - * the clock producer. (IOW, @id may be identical strings, but - * clk_get may return different clock producers depending on @dev.) + * The implementation uses @dev and @id to determine the clock consumer, and + * thereby the clock producer. (IOW, @id may be identical strings, but clk_get + * may return different clock producers depending on @dev.) * * Drivers must assume that the clock source is not enabled. * - * devm_clk_get should not be called from within interrupt context. - * * The clock will automatically be freed when the device is unbound * from the bus. + * + * Return: + * a struct clk corresponding to the clock producer, or + * valid IS_ERR() condition containing errno */ struct clk *devm_clk_get(struct udevice *dev, const char *id); /** - * devm_clk_get_optional - lookup and obtain a managed reference to an optional - * clock producer. + * devm_clk_get_optional() - lookup and obtain a managed reference to an + * optional clock producer. * @dev: device for clock "consumer" * @id: clock consumer ID * * Behaves the same as devm_clk_get() except where there is no clock producer. - * In this case, instead of returning -ENOENT, the function returns NULL. + * In this case, instead of returning -%ENOENT, the function returns NULL. */ static inline struct clk *devm_clk_get_optional(struct udevice *dev, const char *id) @@ -236,14 +237,15 @@ static inline struct clk *devm_clk_get_optional(struct udevice *dev, /** * clk_release_all() - Disable (turn off)/Free an array of previously * requested clocks. - * - * For each clock contained in the clock array, this function will check if - * clock has been previously requested and then will disable and free it. - * * @clk: A clock struct array that was previously successfully * requested by clk_request/get_by_*(). - * @count Number of clock contained in the array - * @return zero on success, or -ve error code. + * @count: Number of clock contained in the array + * + * For each clock contained in the clock array, this function will check if + * clock has been previously requested and then will disable and free it. + * + * + * Return: zero on success, or -ve error code. */ int clk_release_all(struct clk *clk, int count); @@ -297,10 +299,10 @@ static inline int clk_release_all(struct clk *clk, int count) * @name: The name of the clock to request. * @name: The name of the clock to request, within the client's list of * clocks. - * @clock: A pointer to a clock struct to initialize. + * @clk: A pointer to a clock struct to initialize. * * Behaves the same as clk_get_by_name_nodev() except where there is - * no clock producer, in this case, skip the error number -ENODATA, and + * no clock producer, in this case, skip the error number -%ENODATA, and * the function returns 0. */ static inline int clk_get_by_name_nodev_optional(ofnode node, const char *name, @@ -340,12 +342,13 @@ enum clk_defaults_stage { #if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(CLK) /** - * clk_set_defaults - Process 'assigned-{clocks/clock-parents/clock-rates}' + * clk_set_defaults - Process ``assigned-{clocks/clock-parents/clock-rates}`` * properties to configure clocks - * * @dev: A device to process (the ofnode associated with this device * will be processed). * @stage: The stage of the probing process this function is called during. + * + * Return: zero on success, or -ve error code. */ int clk_set_defaults(struct udevice *dev, enum clk_defaults_stage stage); #else @@ -358,13 +361,13 @@ static inline int clk_set_defaults(struct udevice *dev, int stage) /** * clk_release_bulk() - Disable (turn off)/Free an array of previously * requested clocks in a clock bulk struct. + * @bulk: A clock bulk struct that was previously successfully + * requested by clk_get_bulk(). * * For each clock contained in the clock bulk struct, this function will check * if clock has been previously requested and then will disable and free it. * - * @clk: A clock bulk struct that was previously successfully - * requested by clk_get_bulk(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ static inline int clk_release_bulk(struct clk_bulk *bulk) { @@ -373,135 +376,135 @@ static inline int clk_release_bulk(struct clk_bulk *bulk) #if CONFIG_IS_ENABLED(CLK) /** - * clk_request - Request a clock by provider-specific ID. + * clk_request() - Request a clock by provider-specific ID. + * @dev: The clock provider device. + * @clk: A pointer to a clock struct to initialize. The caller must + * have already initialized any field in this struct which the + * clock provider uses to identify the clock. * * This requests a clock using a provider-specific ID. Generally, this function * should not be used, since clk_get_by_index/name() provide an interface that * better separates clients from intimate knowledge of clock providers. * However, this function may be useful in core SoC-specific code. * - * @dev: The clock provider device. - * @clock: A pointer to a clock struct to initialize. The caller must - * have already initialized any field in this struct which the - * clock provider uses to identify the clock. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_request(struct udevice *dev, struct clk *clk); /** - * clk_free - Free a previously requested clock. - * - * @clock: A clock struct that was previously successfully requested by + * clk_free() - Free a previously requested clock. + * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return 0 if OK, or a negative error code. + * + * Return: 0 if OK, or a negative error code. */ int clk_free(struct clk *clk); /** * clk_get_rate() - Get current clock rate. - * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return clock rate in Hz on success, 0 for invalid clock, or -ve error code + * + * Return: clock rate in Hz on success, 0 for invalid clock, or -ve error code * for other errors. */ ulong clk_get_rate(struct clk *clk); /** * clk_get_parent() - Get current clock's parent. - * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return pointer to parent's struct clk, or error code passed as pointer + * + * Return: pointer to parent's struct clk, or error code passed as pointer */ struct clk *clk_get_parent(struct clk *clk); /** * clk_get_parent_rate() - Get parent of current clock rate. - * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return clock rate in Hz, or -ve error code. + * + * Return: clock rate in Hz, or -ve error code. */ long long clk_get_parent_rate(struct clk *clk); /** * clk_round_rate() - Adjust a rate to the exact rate a clock can provide + * @clk: A clock struct that was previously successfully requested by + * clk_request/get_by_*(). + * @rate: desired clock rate in Hz. * * This answers the question "if I were to pass @rate to clk_set_rate(), * what clock rate would I end up with?" without changing the hardware - * in any way. In other words: + * in any way. In other words:: * * rate = clk_round_rate(clk, r); * - * and: + * and:: * * rate = clk_set_rate(clk, r); * * are equivalent except the former does not modify the clock hardware * in any way. * - * @clk: A clock struct that was previously successfully requested by - * clk_request/get_by_*(). - * @rate: desired clock rate in Hz. - * @return rounded rate in Hz, or -ve error code. + * Return: rounded rate in Hz, or -ve error code. */ ulong clk_round_rate(struct clk *clk, ulong rate); /** * clk_set_rate() - Set current clock rate. - * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @rate: New clock rate in Hz. - * @return new rate, or -ve error code. + * + * Return: new rate, or -ve error code. */ ulong clk_set_rate(struct clk *clk, ulong rate); /** * clk_set_parent() - Set current clock parent. - * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @parent: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return new rate, or -ve error code. + * + * Return: new rate, or -ve error code. */ int clk_set_parent(struct clk *clk, struct clk *parent); /** * clk_enable() - Enable (turn on) a clock. - * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return zero on success, or -ve error code. + * + * Return: zero on success, or -ve error code. */ int clk_enable(struct clk *clk); /** * clk_enable_bulk() - Enable (turn on) all clocks in a clock bulk struct. - * * @bulk: A clock bulk struct that was previously successfully requested * by clk_get_bulk(). - * @return zero on success, or -ve error code. + * + * Return: zero on success, or -ve error code. */ int clk_enable_bulk(struct clk_bulk *bulk); /** * clk_disable() - Disable (turn off) a clock. - * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return zero on success, or -ve error code. + * + * Return: zero on success, or -ve error code. */ int clk_disable(struct clk *clk); /** * clk_disable_bulk() - Disable (turn off) all clocks in a clock bulk struct. - * * @bulk: A clock bulk struct that was previously successfully requested * by clk_get_bulk(). - * @return zero on success, or -ve error code. + * + * Return: zero on success, or -ve error code. */ int clk_disable_bulk(struct clk_bulk *bulk); @@ -510,30 +513,28 @@ int clk_disable_bulk(struct clk_bulk *bulk); * @p: clk compared against q * @q: clk compared against p * - * Returns true if the two struct clk pointers both point to the same hardware - * clock node. - * - * Returns false otherwise. Note that two NULL clks are treated as matching. + * Return: + * %true if the two struct clk pointers both point to the same hardware clock + * node, and %false otherwise. Note that two %NULL clks are treated as matching. */ bool clk_is_match(const struct clk *p, const struct clk *q); /** * clk_get_by_id() - Get the clock by its ID - * * @id: The clock ID to search for * * @clkp: A pointer to clock struct that has been found among added clocks * to UCLASS_CLK - * @return zero on success, or -ENOENT on error + * + * Return: zero on success, or -%ENOENT on error */ int clk_get_by_id(ulong id, struct clk **clkp); /** * clk_dev_binded() - Check whether the clk has a device binded + * @clk: A pointer to the clk * - * @clk A pointer to the clk - * - * @return true on binded, or false on no + * Return: %true if binded, or %false */ bool clk_dev_binded(struct clk *clk); @@ -617,9 +618,9 @@ static inline bool clk_dev_binded(struct clk *clk) /** * clk_valid() - check if clk is valid - * * @clk: the clock to check - * @return true if valid, or false + * + * Return: %true if valid, or %false */ static inline bool clk_valid(struct clk *clk) {