Received: by 2002:a25:8b91:0:0:0:0:0 with SMTP id j17csp20929900ybl; Sun, 5 Jan 2020 15:16:37 -0800 (PST) X-Google-Smtp-Source: APXvYqxJgSUd5n4XI/CFbhXv0f8XFzF92jd3+i2Ya6YksimtHctJJjV+rdAcJd3aBDy6LvChXuoA X-Received: by 2002:a9d:32f:: with SMTP id 44mr62767965otv.234.1578266196978; Sun, 05 Jan 2020 15:16:36 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1578266196; cv=none; d=google.com; s=arc-20160816; b=lJcrGpi2Y2+UW82z09pGxZ+IGWfUOR7RZM2JwDuFGxRSqX3aEMv5JxgBp4pjDpa5dA PrIekDqKabeBHGWxTUOCdVS686ailwxnFw4CjzpkvH3fapPs4MmzutJPaFXDvIUgQWi5 VIWBL6mAJb7WUvpS5u27HWKxnyw+o7sGuD8KQ/0OWc7D6D2RpItaJcAycXTr6bilyQNq juTsgO/3yQW1lH9bASj0ohV5phbk3UuplwGQVU+GQdA3BfNVXwVRcBNLI+2T7WFCWMOO /ML2tTzcxDlYfvnAbtQo3Zkcl7xQL45YUU3wmwPIifL6i5hA6fMVqfK4FTdhk9ksT3YU qWHA== 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=+ITQfsiIM82Wynk4K4PvqLPKwISYOEuMBNDKFv+N8TM=; b=JyiNSfUD4TUr4RqD0PezNXD1sSDZiRoEBxtwia0j0EE0N0DopnWR2p+xOHUgaSiP0E CI9TwRDTj80Jn5dx6eo3CWKOabeCR4wYqqQ2IIjxESHoQZj2I8HgcSkTHfyLuYWUXmER H3jcPKoMW2gJZXGYYrbqs8Xb5r/JmovtvMjGbDBWH9EiiT4ujDmPnc5zzzyCJxpDWv/0 J45hsqi36E6bNO2LhbkzMTfSnOSvzmUxjO8NIWJYzhhFq1iV2llcoTQQiM17hcLTQTMd KRiV9wFk8NnLspPtfvcofPz8o1LLrzz4R9rln091rPTKdOQNWAY4peQOZlR9EuqPhz5n qjWg== 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 r10si35531533otn.241.2020.01.05.15.16.24; Sun, 05 Jan 2020 15:16:36 -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 S1727319AbgAEXPL (ORCPT + 99 others); Sun, 5 Jan 2020 18:15:11 -0500 Received: from hostingweb31-40.netsons.net ([89.40.174.40]:50374 "EHLO hostingweb31-40.netsons.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727256AbgAEXPK (ORCPT ); Sun, 5 Jan 2020 18:15:10 -0500 Received: from [37.160.42.38] (port=5507 helo=melee.fritz.box) by hostingweb31.netsons.net with esmtpa (Exim 4.92) (envelope-from ) id 1ioEkF-00GSqI-M5; Sun, 05 Jan 2020 23:51:39 +0100 From: Luca Ceresoli To: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org Cc: Luca Ceresoli , Wolfram Sang , Peter Rosin , linux-kernel@vger.kernel.org Subject: [PATCH 21/26] docs: i2c: instantiating-devices: rearrange static instatiation Date: Sun, 5 Jan 2020 23:50:07 +0100 Message-Id: <20200105225012.11701-21-luca@lucaceresoli.net> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200105225012.11701-1-luca@lucaceresoli.net> References: <20200105224006.10321-1-luca@lucaceresoli.net> <20200105225012.11701-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 --- Documentation/i2c/instantiating-devices.rst | 98 ++++++++++++--------- 1 file changed, 54 insertions(+), 44 deletions(-) diff --git a/Documentation/i2c/instantiating-devices.rst b/Documentation/i2c/instantiating-devices.rst index 5debaafef64d..cbcafb36b417 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:: @@ -81,14 +54,51 @@ Here, two devices are attached to the bus using a speed of 100kHz. For 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.24.1