From patchwork Fri Jan 24 06:28:04 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Baruch Siach X-Patchwork-Id: 3533041 Return-Path: X-Original-To: patchwork-linux-spi@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 0213D9F1C4 for ; Fri, 24 Jan 2014 06:29:32 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 2EB41201B6 for ; Fri, 24 Jan 2014 06:29:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 8A800201BB for ; Fri, 24 Jan 2014 06:29:26 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1750978AbaAXG3P (ORCPT ); Fri, 24 Jan 2014 01:29:15 -0500 Received: from guitar.tcltek.co.il ([192.115.133.116]:37659 "EHLO mx.tkos.co.il" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751210AbaAXG3O (ORCPT ); Fri, 24 Jan 2014 01:29:14 -0500 Received: from tarshish.tkos.co.il (unknown [10.0.8.6]) by mx.tkos.co.il (Postfix) with ESMTPSA id 3036A440AB4; Fri, 24 Jan 2014 08:29:11 +0200 (IST) From: Baruch Siach To: Mark Brown Cc: linux-spi@vger.kernel.org, Baruch Siach Subject: [PATCH 1/3] spi: spi.h: clarify the documentation of transfer_one Date: Fri, 24 Jan 2014 08:28:04 +0200 Message-Id: <39ffc897bd2e5fd48a3141ed4cd122a80c5bbb20.1390544495.git.baruch@tkos.co.il> X-Mailer: git-send-email 1.8.5.2 In-Reply-To: References: Sender: linux-spi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-spi@vger.kernel.org X-Spam-Status: No, score=-7.5 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=ham 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 Explicitly note the transfer_one and transfer_one_message are mutually exclusive, to make the text a little more newcomers friendly. Signed-off-by: Baruch Siach --- include/linux/spi/spi.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/include/linux/spi/spi.h b/include/linux/spi/spi.h index 8c62ba74dd91..060b21e82e73 100644 --- a/include/linux/spi/spi.h +++ b/include/linux/spi/spi.h @@ -285,7 +285,9 @@ static inline void spi_unregister_driver(struct spi_driver *sdrv) * @transfer_one: transfer a single spi_transfer. When the * driver is finished with this transfer it must call * spi_finalize_current_transfer() so the subsystem can issue - * the next transfer + * the next transfer. Note: transfer_one and + * transfer_one_message are mutually exclusive; when both are + * set, transfer_one takes precedence. * @unprepare_message: undo any work done by prepare_message(). * @cs_gpios: Array of GPIOs to use as chip select lines; one per CS * number. Any individual value may be -ENOENT for CS lines that