From patchwork Thu Apr 19 22:23:56 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sam Hansen X-Patchwork-Id: 901546 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=linux-i2c-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="OqJJVbkj"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 40RtnT6WVXz9s3F for ; Fri, 20 Apr 2018 08:24:13 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753764AbeDSWYM (ORCPT ); Thu, 19 Apr 2018 18:24:12 -0400 Received: from mail-io0-f201.google.com ([209.85.223.201]:34031 "EHLO mail-io0-f201.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753509AbeDSWYK (ORCPT ); Thu, 19 Apr 2018 18:24:10 -0400 Received: by mail-io0-f201.google.com with SMTP id f6-v6so4740995ioc.1 for ; Thu, 19 Apr 2018 15:24:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=mime-version:date:message-id:subject:from:to:cc; bh=oZSNGhrEgWv0ra2tL36T22nFrCZfE3//iOUNFFGTBes=; b=OqJJVbkjwf8Aty81+yEIAKc9XIlaMPkSIxveejTnfbIY1i72nRp9iSYrZESOt25CBL eoguVyUaNCqbL/P8/urEF53TOj+8k+XKd5lGX6O2yKo0BLI2ylfx5pmsUlcaJn2GPLfA 0LzNaB7kZlhvNMCVaMsTfhkRvL3RpdvAJl684KYOQd00uOFw6vPqTPOiZTeDwJ+O3H9I /PwNFID4RifFRShyOAZswu/2SDEI695/c+qhjl9PhOR43IWY7rUJ7Gzlie+ImvQ10h0X wa70S/PgBUI/kDDc4+l0Rs2wX+/Vx98Fux3Gt95HvLmexvrTEp+ePt0+NLiXvekUE6uZ w4sg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:date:message-id:subject:from:to:cc; bh=oZSNGhrEgWv0ra2tL36T22nFrCZfE3//iOUNFFGTBes=; b=lrfufYgdbQGoprrEGByH9HjHPfyQ5Uol0PGx0rfUvYlVYBJxyoesK4cW08qDh3JzmP 6+EcFkE/G6RDfzxvT+AExVZ+Np5tsx/Yhf0OkOvC1RcPEwZmopJF7BigLM2qC5TxIuD/ 6G1mzfgSsnvESes9YnNNAQkNpQSYJjQMcpmJayFAkQu5uqdfLJtsb8z3r8teh6EA+mLu 1ZWRvw2DApTkmb80j5D+CdX+krGPenxb/BGnOy3FJdB9N7MIC7sdfwdZZxToSg8tetbW XJkqoqJT731u3zvglQxTYeL5CBPLJSgkJvtYUyT8OP1j/761G0nJs/3cz8QV7MFOKuI3 19Vw== X-Gm-Message-State: ALQs6tDkBmuM5FTXLM0LZ/TPqem4NXO/bduWWXApvO1GBKGyXXw1kYY5 g65LSJmmjzJyq3TJ1WHefrOVNYQ03RiMIZa/PGF5F6+qLj72FjPOIMa9CLGn3U0AZQpmnRKJxSv oHG7y2Bs0sg7DBxSovcg03sy5GxfahTj5OWyx1ap9omyOjLrZtFm5YZXNrViaWXKPPmMJ X-Google-Smtp-Source: AIpwx48ivyS6m9U1K1dqSCr4G1bosaOHMfLh0H7LHthsL9T92/uLkzL1nK64O3YdrhQOgS4tZ6MhGrqnDKNL MIME-Version: 1.0 X-Received: by 2002:a24:764f:: with SMTP id z76-v6mr319565itb.11.1524176650165; Thu, 19 Apr 2018 15:24:10 -0700 (PDT) Date: Thu, 19 Apr 2018 15:23:56 -0700 Message-Id: <20180419222356.242535-1-hansens@google.com> X-Mailer: git-send-email 2.17.0.484.g0c8726318c-goog Subject: [PATCH] Documentation/i2c: direct users to i2c-tools regarding i2c/smbus.h From: Sam Hansen To: linux-i2c@vger.kernel.org, jdelvare@suse.de, hansens@google.com, wsa@the-dreams.de, corbet@lwn.net, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Cc: jdelvare@suse.de, Sam Hansen , wsa@the-dreams.de, corbet@lwn.net, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Sender: linux-i2c-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org The current examples reference i2c/smbus.h, which is the first reference in Documentation/i2c/dev-interface to anything related to the i2c-tools project. This moves the existing reference to i2c-tools up into the C-example, directing the user to the project's git repository. Signed-off-by: Sam Hansen --- Documentation/i2c/dev-interface | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/i2c/dev-interface b/Documentation/i2c/dev-interface index fbed645ccd75..ed20f7b7851a 100644 --- a/Documentation/i2c/dev-interface +++ b/Documentation/i2c/dev-interface @@ -23,6 +23,10 @@ First, you need to include these two headers: #include #include +The i2c/smbus header file is provided by the i2c-tools project. For more info +about i2c-tools, see: +https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/ + Now, you have to decide which adapter you want to access. You should inspect /sys/class/i2c-dev/ or run "i2cdetect -l" to decide this. Adapter numbers are assigned somewhat dynamically, so you can not @@ -163,10 +167,6 @@ what happened. The 'write' transactions return 0 on success; the returns the number of values read. The block buffers need not be longer than 32 bytes. -The above functions are made available by linking against the libi2c library, -which is provided by the i2c-tools project. See: -https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/. - Implementation details ======================