Received: by 2002:a25:8b91:0:0:0:0:0 with SMTP id j17csp714697ybl; Wed, 29 Jan 2020 08:26:06 -0800 (PST) X-Google-Smtp-Source: APXvYqzfG2yJXVSrFHQT6qbv46DYATnJJpgMTBMmqNyQSHxJz8F5sqIQnr8cf6q6XJfQFRB51e07 X-Received: by 2002:a05:6830:154a:: with SMTP id l10mr75827otp.44.1580315166315; Wed, 29 Jan 2020 08:26:06 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1580315166; cv=none; d=google.com; s=arc-20160816; b=exlEgUIZz6D6I2vAADZjaxGD4KhUyHe0AA+I9gG1WeD6CKWRwQLndYddkl3DZqV73H JwKFeTXmi/hQUmQrOdrQM2c90AcnGPySRavX+ifjq42kCQi+iDl8RhC3oiWVqZYvttxZ +tm90xi4aMFX9QPnik5pMTr85rIZTUpBH5eVCjMSgO6O2nuN1NoIKCcBc+VlTw5tfEN3 GCHWgWMqRFnVqhIwTnFS/MTbvDxwT13Mkn156oZb3U7qqpIm4IqNYcguLK2HLJTX4PDV N+i2Xm8xUsNzvZs9Du8pT76iVQNDxqA9suTIvRcUmslIVFF7hI4RiMw7qEe4PftSZeMK nIRA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=5V6I37gO4KdPZLyZ7yZ05XGCE4Xm1k7DOFTKIDmnY2A=; b=q/tyjrS1pHYB5rSdIhDeLgjNOig9E/ysND5qljJ0NhPB6YJnl/RG9iouzutdSBKJQk 45iCE3GQAF1TwPj71jxbgPB0fcpOwQNqJHDd3U4LyNeVL1afQu7HXLhqGXYo692mbJDh cSDMrUtKQfNOobcSsKRFHI62IOA0BthPOo32BasUiRn3V9mjrKTzKcfOiz+nqtES9jVm 5byTBvxweKYOiQe07BFik1jmVVVMY9l9+yriSdm5PPI7Mvup8N12EYc9I00MBHkcK7cX I3JqG7zCUPTxWa4VJGTz8Vim2ml8b31vG+oGotTddFHc9JQcGnuIZXOvG31g7FA24Htx KlJg== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id m26si1442621otn.307.2020.01.29.08.25.54; Wed, 29 Jan 2020 08:26:06 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727321AbgA2QX3 (ORCPT + 99 others); Wed, 29 Jan 2020 11:23:29 -0500 Received: from hostingweb31-40.netsons.net ([89.40.174.40]:51659 "EHLO hostingweb31-40.netsons.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727174AbgA2QWy (ORCPT ); Wed, 29 Jan 2020 11:22:54 -0500 Received: from [109.168.11.45] (port=34038 helo=pc-ceresoli.dev.aim) by hostingweb31.netsons.net with esmtpa (Exim 4.92) (envelope-from ) id 1iwq79-005NDl-RX; Wed, 29 Jan 2020 17:22:51 +0100 From: Luca Ceresoli To: linux-i2c@vger.kernel.org, linux-doc@vger.kernel.org Cc: Luca Ceresoli , Wolfram Sang , Jean Delvare , Peter Rosin , linux-kernel@vger.kernel.org Subject: [PATCH v3 21/28] docs: i2c: instantiating-devices: rearrange static instatiation Date: Wed, 29 Jan 2020 16:19:46 +0100 Message-Id: <20200129151953.31582-22-luca@lucaceresoli.net> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200129151953.31582-1-luca@lucaceresoli.net> References: <20200129151953.31582-1-luca@lucaceresoli.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - hostingweb31.netsons.net X-AntiAbuse: Original Domain - vger.kernel.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - lucaceresoli.net X-Get-Message-Sender-Via: hostingweb31.netsons.net: authenticated_id: luca+lucaceresoli.net/only user confirmed/virtual account not confirmed X-Authenticated-Sender: hostingweb31.netsons.net: luca@lucaceresoli.net X-Source: X-Source-Args: X-Source-Dir: Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Among the "static" instantiation methods the "board file" method is described first. Move it as last, since it is being replaced by the other methods. Also fix subsubsection heading syntax and remove the "Method 1[abc]" prefix as the subsubsection structure clarifies the logical hierarchy. Signed-off-by: Luca Ceresoli Reviewed-by: Jean Delvare --- Changes in v2: - add clarifying commas, make empty lines consistent (Jean Delvare) --- Documentation/i2c/instantiating-devices.rst | 97 ++++++++++++--------- 1 file changed, 54 insertions(+), 43 deletions(-) diff --git a/Documentation/i2c/instantiating-devices.rst b/Documentation/i2c/instantiating-devices.rst index e823c4ad4e7f..665bf00792ba 100644 --- a/Documentation/i2c/instantiating-devices.rst +++ b/Documentation/i2c/instantiating-devices.rst @@ -9,54 +9,27 @@ reason, the kernel code must instantiate I2C devices explicitly. There are several ways to achieve this, depending on the context and requirements. -Method 1a: Declare the I2C devices by bus number ------------------------------------------------- +Method 1: Declare the I2C devices statically +-------------------------------------------- This method is appropriate when the I2C bus is a system bus as is the case -for many embedded systems. On such systems, each I2C bus has a number -which is known in advance. It is thus possible to pre-declare the I2C -devices which live on this bus. This is done with an array of struct -i2c_board_info which is registered by calling i2c_register_board_info(). +for many embedded systems. On such systems, each I2C bus has a number which +is known in advance. It is thus possible to pre-declare the I2C devices +which live on this bus. -Example (from omap2 h4):: +This information is provided to the kernel in a different way on different +architectures: device tree, ACPI or board files. - static struct i2c_board_info h4_i2c_board_info[] __initdata = { - { - I2C_BOARD_INFO("isp1301_omap", 0x2d), - .irq = OMAP_GPIO_IRQ(125), - }, - { /* EEPROM on mainboard */ - I2C_BOARD_INFO("24c01", 0x52), - .platform_data = &m24c01, - }, - { /* EEPROM on cpu card */ - I2C_BOARD_INFO("24c01", 0x57), - .platform_data = &m24c01, - }, - }; - - static void __init omap_h4_init(void) - { - (...) - i2c_register_board_info(1, h4_i2c_board_info, - ARRAY_SIZE(h4_i2c_board_info)); - (...) - } - -The above code declares 3 devices on I2C bus 1, including their respective -addresses and custom data needed by their drivers. When the I2C bus in -question is registered, the I2C devices will be instantiated automatically -by i2c-core. +When the I2C bus in question is registered, the I2C devices will be +instantiated automatically by i2c-core. The devices will be automatically +unbound and destroyed when the I2C bus they sit on goes away (if ever). -The devices will be automatically unbound and destroyed when the I2C bus -they sit on goes away (if ever.) +Declare the I2C devices via devicetree +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Method 1b: Declare the I2C devices via devicetree -------------------------------------------------- - -This method has the same implications as method 1a. The declaration of I2C -devices is here done via devicetree as subnodes of the master controller. +On platforms using devicetree, the declaration of I2C devices is done in +subnodes of the master controller. Example:: @@ -82,13 +55,51 @@ additional properties which might be needed to set up the device, please refer to its devicetree documentation in Documentation/devicetree/bindings/. -Method 1c: Declare the I2C devices via ACPI -------------------------------------------- +Declare the I2C devices via ACPI +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ACPI can also describe I2C devices. There is special documentation for this which is currently located at :doc:`../firmware-guide/acpi/enumeration`. +Declare the I2C devices in board files +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In many embedded architectures, devicetree has replaced the old hardware +description based on board files, but the latter are still used in old +code. Instantiating I2C devices via board files is done with an array of +struct i2c_board_info which is registered by calling +i2c_register_board_info(). + +Example (from omap2 h4):: + + static struct i2c_board_info h4_i2c_board_info[] __initdata = { + { + I2C_BOARD_INFO("isp1301_omap", 0x2d), + .irq = OMAP_GPIO_IRQ(125), + }, + { /* EEPROM on mainboard */ + I2C_BOARD_INFO("24c01", 0x52), + .platform_data = &m24c01, + }, + { /* EEPROM on cpu card */ + I2C_BOARD_INFO("24c01", 0x57), + .platform_data = &m24c01, + }, + }; + + static void __init omap_h4_init(void) + { + (...) + i2c_register_board_info(1, h4_i2c_board_info, + ARRAY_SIZE(h4_i2c_board_info)); + (...) + } + +The above code declares 3 devices on I2C bus 1, including their respective +addresses and custom data needed by their drivers. + + Method 2: Instantiate the devices explicitly -------------------------------------------- -- 2.25.0