From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752247AbdLLIq6 (ORCPT ); Tue, 12 Dec 2017 03:46:58 -0500 Received: from mail-he1eur01on0115.outbound.protection.outlook.com ([104.47.0.115]:26207 "EHLO EUR01-HE1-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1750715AbdLLIqs (ORCPT ); Tue, 12 Dec 2017 03:46:48 -0500 Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=peda@axentia.se; From: Peter Rosin To: linux-kernel@vger.kernel.org Cc: Peter Rosin , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH v2 2/2] docs: add mux docs to the driver-api docs Date: Tue, 12 Dec 2017 09:46:33 +0100 Message-Id: <20171212084633.532-3-peda@axentia.se> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20171212084633.532-1-peda@axentia.se> References: <20171212084633.532-1-peda@axentia.se> MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [85.226.244.23] X-ClientProxiedBy: AM4PR0202CA0017.eurprd02.prod.outlook.com (2603:10a6:200:89::27) To AM5PR0202MB2545.eurprd02.prod.outlook.com (2603:10a6:203:6c::23) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 56e023c7-af87-44b1-f86d-08d5413cddf7 X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:(4534020)(4602075)(4603075)(4627115)(201702281549075)(5600026)(4604075)(2017052603307);SRVR:AM5PR0202MB2545; X-Microsoft-Exchange-Diagnostics: 1;AM5PR0202MB2545;3:f+36i/VIFISjJdfrhToTuxgvqTg/xjjiFS+66kdYKnBgozULz/TX6A9MBnobfPNOeBNu3iX+G5bLJOzSDxSShkDg1StyrLGXKRniZZ0yhHRXqUn8VDAsOMXyjRarSNZQ/65q0cnFzHKqzTWKOGfkxBb4oq4usUy05FWx3UKzux085PWJwLBpSbqVHwT1IsswmME87YsSAVfvqSGX/jGQtkJorkz3IUewcpZGoDt+qsIHaXi5eDq+aA0YzMNQwgdO;25:sdqEDb+A1uvKqpEC921HePEoW+3m4x0rX2J3pbqQWSsB5J9mZmePjPycaz2NOqwBtS2feK468JGKyhwycx2g3+N8arQzeTjKutozPY3TArYu2GwgXV9konY+J4sZFU3m0N8OtDDwKBsDMWMevP5HLFl7WHev6oSFHG9A5Ca/fGWbZWXjzJAYJD7SrYZ0MPCAIGzTh9bxNZU0VRMRY8lswSKwYnfbsPRL6hBn+Uelyg/vBC4iWCBfDgOdkr446hiljEe9Vkuv5YqfIcd2qWT7te75aFCtDQcHuBI9pXpBBWo49LAfPWnh1SVV5irmJkNXqhBjbYeGjY4UR/VVl+EGrw==;31:sq84yXKs1qz7tfuiNU+SGYpbKn7T8+UpcT3o3AdlzmZG9stA+d2f51P+wUVXbj7HOlJ+46B3/Gs82vIGGMWNrifyruOhlwhVf9T7DxQRsDqdQMoHO7hubcQjOPqY7l1LJ6QKPslTpZXWVp3SjycyZ4RfJ8CrJDexK2LYtx2yKtxHN45yOqICuWOrQG/CqaT1QoRpfB6QEWbuYoY+7SwwCJFjEjdjWcno8qWsJXW11B4= X-MS-TrafficTypeDiagnostic: AM5PR0202MB2545: X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-Exchange-Antispam-Report-CFA-Test: BCL:0;PCL:0;RULEID:(6040450)(2401047)(5005006)(8121501046)(3002001)(93006095)(93001095)(10201501046)(3231023)(6041248)(2016111802025)(20161123562025)(20161123555025)(20161123560025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123564025)(20161123558100)(6072148)(6043046)(201708071742011);SRVR:AM5PR0202MB2545;BCL:0;PCL:0;RULEID:(100000803101)(100110400095);SRVR:AM5PR0202MB2545; X-Microsoft-Exchange-Diagnostics: 1;AM5PR0202MB2545;4:Ad3Fy78Lc7ShejqNSZiDnfPLQp6UOh2Zjb+LOJS6HygylJG+IVh5/xi/AYj8tYPcFPR0LPdzbnMYQcdG/5bVBCKLq5RsWsRBmOBh+IDGDcBHDbioERLy6I3FD28E17tqn+FnYm2sjjlbtTVvABF8JarsjfkG7yr/g9nw2STrofCRJH26J2etQ5RiDSoBl9ERI5ILv1q9Zb5VmnkU59jD6RzkVxxPFbuPneQipbjPNjqYQzekFh/0dDnB1qAYWN0QA9O8nosazofMQpppm19urw== X-Forefront-PRVS: 051900244E X-Forefront-Antispam-Report: SFV:NSPM;SFS:(10019020)(366004)(39830400002)(346002)(376002)(199004)(189003)(16526018)(53936002)(74482002)(50466002)(6512007)(105586002)(8936002)(25786009)(2950100002)(76176011)(2906002)(52116002)(51416003)(6486002)(6506006)(575784001)(5660300001)(478600001)(106356001)(6666003)(6916009)(54906003)(4326008)(7736002)(86362001)(305945005)(16586007)(3846002)(6116002)(36756003)(8676002)(97736004)(81166006)(66066001)(316002)(2361001)(68736007)(47776003)(2351001)(1076002)(81156014)(48376002)(50226002)(42262002);DIR:OUT;SFP:1102;SCL:1;SRVR:AM5PR0202MB2545;H:orc.pedanet;FPR:;SPF:None;PTR:InfoNoRecords;A:1;MX:1;LANG:en; X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1;AM5PR0202MB2545;23:Rea6C42AWcGMqB95n7HyzFR6rAYaxaqRhZF+tnr?= =?us-ascii?Q?G7MqA7KbsEaK0sBeaf50+02T0zB+A+Mqcapg8zyUB4eimX4cWk/HTgeG3GNz?= =?us-ascii?Q?5T/s1mNQILvkGs/H5tbmGPqybIFxj6GAE0NA4csGCTd2quYPrIBCTE0nIDLg?= =?us-ascii?Q?jcF2XDPrkxtECRO9KM1b38MJtLA8AUaY3/LohNclKwqqSNJm+yDtzk6Xfzb0?= =?us-ascii?Q?U/5tqhpIBhHyORCP982OruyAJc0pwRUpy3/S5KjXJZ1/H7f7FSFUjAaL/Iph?= =?us-ascii?Q?4d45yJgXTaprlkfFBwn8715jLJsdABD1/fa81Eiw1QamBp/Z69xChzxqz98R?= =?us-ascii?Q?XlP88Y0lIpQMcMP8q4Atir3LDY0k225Us+hUTXJDBEb8mYFWd+vb5pHASIwA?= =?us-ascii?Q?5belY/1SUDHekRmBXQ/PcYbS2iX0gTGFbeZOwaCKsPx0yP0UptSTIZ3GoyiV?= =?us-ascii?Q?QaQsjj9WrjupocXz6aarMQrtx66MRd02pe/m78Mh4Qg6XZrO6QyUyY/bc7Sh?= =?us-ascii?Q?4qp9xg41CMle77+tFLDKYVc8CFo8SGW/qvJ/OgGeTqDdPlostuxVj/TCY2NY?= =?us-ascii?Q?/DlZYogi61woGnfw2hQAtrwogHchAZ7b57rMJ7hVxInAE2PoZ25KU8WbBApZ?= =?us-ascii?Q?nqHcU0949/w3nTOW0Bm7CXiOh2Mz+bAlcL/IqFFIH+kZVqmdp+EBdhwsGHS2?= =?us-ascii?Q?iZHwxpfkD3Rht0qrNM76ox7s6IkETap2RXvZZ1sPGpT03uE2oIubKsshMpbz?= =?us-ascii?Q?fAyEHQjxCR8ttnUHLRLgmg9WCUVWJFmV85WpXHnMYblCJBJLEgpteYU6KFuG?= =?us-ascii?Q?rEroGFyOFj9NNrKJIV9AF1YuJwiCjae8az3V0yujvYT4GJ/V3hhbXp6IeFQG?= =?us-ascii?Q?WQ5x65Dxvi+sLZupilo9TtlSsE09M8IGkuPCuGv98bVYdPhnn7SfWGI414eN?= =?us-ascii?Q?RfZAxrRwjpR7xCXryWz+7B1GdfXlGPPy8K2H3Uu/iYygGXUcJH6SAs3DELsZ?= =?us-ascii?Q?H1WhtZhq9T6SrYbN/3YlR+bQ0uRrGeGtKLymMU9Gd+2mj3yhQwRGeS9huVtw?= =?us-ascii?Q?BthPPsui29+ZRkze/5NcxTluF3MEntt21m0o9ws3C42nTNIRFXBNEE+0e+P5?= =?us-ascii?Q?EGaS1zv10PudhtXP40ozVQfNPn7mbI51aX+kq3AAaLyPk9FrsMrxNnQ=3D?= =?us-ascii?Q?=3D?= X-Microsoft-Exchange-Diagnostics: 1;AM5PR0202MB2545;6:A0GKOEjZjYrYy2ff49ufnNX/vUBshsooPldRC2x1+iF6fvhPTdYxiUkC+nCWpRGtsWmDUjJisDMjL3+1bCKLC3rHQJMMTGdzohKtgHNWiq831tp3OAWU5VQcq0kb/inrRBHNMPdz3gGv15223mtpHrobgPMeusMIuG7BmCp+n171QaybjqtiXb44k0lkZSn03pj60ggbpBM5FG4X5Sm7nb+Jj7uzeDLjvA8mzbbiNhZnOL86EexROXFlt6f5wlAjCn6E52/WzmAZWm+7nBHaiv4iUf5LamTdDzi4XJToM5+X2R9OSNDoK695MdgyhB7hVs5xpBzoWL8s79RyFvlj2bZiT1X5IVLE56Y2OkChiUY=;5:JEud70k3tIw31sl+Tijt+qE1WIrAuhcS8xOQ2rLcONl+CeN9hTD6H1iq/mktkv8FQX40Eu+Q5+6TZM0qKQoWQTH1LKBTZbtIrvy5B13e0UhtaEjA7t7BTHAs2CTynhBirmsgczzxncrO4xnNslEK2UHbOBI/oJzeTsyhXRRB2Fw=;24:MRomFeWU+r/u0fNthJLT5s9zdYiMCacteW2u3O3hRf5l/ZUUjrsr1CM8cnnbTsVyHpcwD7OKKx6gD3e4clxdrZlXL2V0cZXHnr5M+XxXtCU=;7:/Nv0TxCv4IdBdGA3BT5TDlsJVKLqpUvenUVYfLqyvZAxuOlbVhcsh2U9Ptew3mdAdja+DBUXLD2FXG6G7BXm0MMS/4yOxSid7jm3u3ZZmNX6tAvWft154uzvVNqM6kRKjsn7iIizMR5K4/Ccoqmn744ip2vmEvbOmaB8YZzjcpzCgEcU5niMyHqZtpY/31akCwgbiCy8qqZp5yRZMkaIwIvZl13tsYwb0VQqgMewSVVJXcEijbULou22pOk2id8D SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: axentia.se X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Dec 2017 08:46:41.8933 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 56e023c7-af87-44b1-f86d-08d5413cddf7 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 4ee68585-03e1-4785-942a-df9c1871a234 X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM5PR0202MB2545 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Include both the overview and the more detailed api docs. Signed-off-by: Peter Rosin --- Documentation/driver-api/index.rst | 1 + Documentation/driver-api/mux.rst | 25 +++++++++++++++++++++++++ MAINTAINERS | 1 + 3 files changed, 27 insertions(+) create mode 100644 Documentation/driver-api/mux.rst diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index d17a9876b473..d10b01b2b429 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -47,6 +47,7 @@ available subsections can be seen below. gpio misc_devices dmaengine/index + mux .. only:: subproject and html diff --git a/Documentation/driver-api/mux.rst b/Documentation/driver-api/mux.rst new file mode 100644 index 000000000000..48fc5108ff0e --- /dev/null +++ b/Documentation/driver-api/mux.rst @@ -0,0 +1,25 @@ +Multiplexer Subsystem +===================== + +A multiplexer is a type of device that selects one of many signals and +forwards this signal to a single output. A variant is a demultiplexer +that instead forwards a single input to one of many outputs. There are +also bidirectional variants. All these variants are handled the same +by the multiplexer subsystem, and can be used to e.g. fan out an I2C +bus to avoid client device address collisions or to allow converting +more signals using a single analog to digital converter. + +Overview +-------- + +.. kernel-doc:: drivers/mux/core.c + :doc: overview + +Details +------- + +.. kernel-doc:: include/linux/mux/driver.h + :internal: + +.. kernel-doc:: drivers/mux/core.c + :export: diff --git a/MAINTAINERS b/MAINTAINERS index d4fdcb12616c..2c0bbabedca0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -9298,6 +9298,7 @@ M: Peter Rosin S: Maintained F: Documentation/ABI/testing/mux/sysfs-class-mux* F: Documentation/devicetree/bindings/mux/ +F: Documentation/driver-api/mux.rst F: include/linux/dt-bindings/mux/ F: include/linux/mux/ F: drivers/mux/ -- 2.11.0