From patchwork Sun Dec 16 10:18:56 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jian-Hong Pan X-Patchwork-Id: 10732443 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id B7CAD924 for ; Sun, 16 Dec 2018 10:20:47 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A5C6629C21 for ; Sun, 16 Dec 2018 10:20:47 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 9A09729C28; Sun, 16 Dec 2018 10:20:47 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 115CA29C21 for ; Sun, 16 Dec 2018 10:20:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730334AbeLPKUH (ORCPT ); Sun, 16 Dec 2018 05:20:07 -0500 Received: from mail-pl1-f193.google.com ([209.85.214.193]:45219 "EHLO mail-pl1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729861AbeLPKUG (ORCPT ); Sun, 16 Dec 2018 05:20:06 -0500 Received: by mail-pl1-f193.google.com with SMTP id a14so4746058plm.12 for ; Sun, 16 Dec 2018 02:20:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=g.ncu.edu.tw; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=PHPOHUSEf09J0y5cet2zObb7uVSKpnQvHKWGF9UR7Is=; b=RD54j+V/qi4y+ErvR6gcyrzqd7FWw9UFcaYYsAAsaAB3V2EG6uLU2nQ8QW6d4KAPcX JL3FH4KTDrT+oOawGgw2BX5dkEWL8qjMssgaYYVMqlQTnSSTGUTdg8p0Ydfj2geFNigV FaflcXkAuQaLrMQJ3nWA5jZdNfgI8KLiZq7mE= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=PHPOHUSEf09J0y5cet2zObb7uVSKpnQvHKWGF9UR7Is=; b=oWjWm/rSQ9BfmQmzcWox3p1UJznGNG6dYldqKSb9kTPa0KMh3CIbOVbuZa8LL8VAEA Qogg/nhZJiJI1d+392p3mzgU5QtDQ48AM3s6kitcqLRIbyevI8w1DdBFfSpaJO/zHAJh DTEOBdBTVTQ6xJCFTwP1jcyXYWzhgI3udh2sRqMkQMN4fS1A0orOjmCpGY3fzOcY+PSD hMmZ9L+tXP4Vn49m3gzI0vfRgYXUIMnOLjmXGP2Tts+MFqQpiw+WCWWK2jyNryAMXJdE xTqGq3PptxQjNuRuBoZdqeOomwIh0QS3TmG/Z41RbehO39MRbppZU/9uG2OaKQb/yC9u y9Fg== X-Gm-Message-State: AA+aEWZsCT8qV8I7oLmjZ/ic7WfY83Ph6Phk3Tyim34cFhDHXtkoi4yz XJ2rjoEQBCaTJy6P/X8UeCQLqQ== X-Google-Smtp-Source: AFSGD/WbXm2rW/wCIYMwCz0IQtVhf2/LkNRGzpkca/a04Y0PVzDbBk/nF/BScSiKAKLTi+yysj+KCA== X-Received: by 2002:a17:902:503:: with SMTP id 3mr9166909plf.233.1544955605471; Sun, 16 Dec 2018 02:20:05 -0800 (PST) Received: from starnight.local ([150.116.255.181]) by smtp.gmail.com with ESMTPSA id d21sm14964454pgv.37.2018.12.16.02.20.03 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 16 Dec 2018 02:20:05 -0800 (PST) From: Jian-Hong Pan To: =?utf-8?q?Andreas_F=C3=A4rber?= , "David S . Miller" , Alan Cox Cc: linux-lpwan@lists.infradead.org, netdev@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Marcel Holtmann , Dollar Chen , Ken Yu , linux-wpan@vger.kernel.org, Jian-Hong Pan Subject: [PATCH v5 2/6] net: lorawan: Add LoRaWAN API declaration for LoRa devices Date: Sun, 16 Dec 2018 18:18:56 +0800 Message-Id: <20181216101858.9585-3-starnight@g.ncu.edu.tw> X-Mailer: git-send-email 2.20.0 In-Reply-To: References: MIME-Version: 1.0 Sender: linux-wpan-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wpan@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add public LoRaWAN API for compatible LoRa device drivers. Signed-off-by: Jian-Hong Pan --- V2: - Split the LoRaWAN class module patch in V1 into LoRaWAN socket and LoRaWAN Soft MAC modules - Merge the lrw_operations: set_bw, set_mod, set_sf into set_dr - Use SPDX license identifiers V3: - Remove the unused lrw_random_addr function V4: - Fix by coding style report from scripts/checkpatch.pl include/linux/lora/lorawan.h | 131 +++++++++++++++++++++++++++++++++++ 1 file changed, 131 insertions(+) create mode 100644 include/linux/lora/lorawan.h diff --git a/include/linux/lora/lorawan.h b/include/linux/lora/lorawan.h new file mode 100644 index 000000000000..201f27521655 --- /dev/null +++ b/include/linux/lora/lorawan.h @@ -0,0 +1,131 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later OR BSD-3-Clause */ +/*- + * LoRaWAN compatible hardware's definitions + * + * Copyright (c) 2018 Jian-Hong, Pan + * + */ + +#ifndef __LORAWAN_H__ +#define __LORAWAN_H__ + +#include + +/* List the role of the LoRaWAN hardware */ +enum { + LRW_GATEWAY, + LRW_CLASS_A_NODE, + LRW_CLASS_B_NODE, + LRW_CLASS_C_NODE, +}; + +/* List the RF modes */ +enum { + LRW_LORA, + LRW_FSK, +}; + +/** + * lrw_dr - This structure holds the RF related configuration of the data rate. + * @bw: + * Bandwidth in Hz + * + * @sf: + * Spread factor of CSS modulation used by LoRa mode + * + * @mode: + * LoRa or FSK mode + */ +struct lrw_dr { + u32 bw; + u8 sf; + u8 mode; +}; + +#define LRW_DEVADDR_LEN (sizeof(__le32)) + +/* List the LoRa device's states of LoRaWAN hardware */ +enum { + LRW_STOP, + LRW_START, + LRW_STATE_IDLE, + LRW_STATE_TX, + LRW_STATE_RX, +}; + +/** + * lrw_hw - This structure holds the LoRa device of LoRaWAN hardware. + * @priv: + * points to the private data of the LoRa device + */ +struct lrw_hw { + void *priv; +}; + +/** + * lrw_operations - Lists the LoRaWAN device/interface's operations. + * These are callback functions for the LoRaWAN module. Compatible LoRa device + * driver should implement some of them according to the usage. The + * unimplemented callback functions must be assigned as NULL. + * + * @start: + * called when the interface is being up state + * + * @stop: + * called when the interface is being down state + * + * @xmit_async: + * called to xmit the data through the interface asynchronously + * + * @set_txpower: + * called to set xmitting RF power in mBm of the interface + * + * @set_frq: + * called to set carrier frequency in Hz of the interface + * + * @set_dr: + * called to set related RF configuration of the LoRaWAN data rate + * + * @start_rx_window: + * called to ask the LoRa device open a receiving window + * + * @set_state: + * called to set the LoRa device's working state + */ +struct lrw_operations { + int (*start)(struct lrw_hw *hw); + void (*stop)(struct lrw_hw *hw); + + int (*xmit_async)(struct lrw_hw *hw, struct sk_buff *skb); + int (*set_txpower)(struct lrw_hw *hw, s32 pwr); + int (*set_frq)(struct lrw_hw *hw, u32 frq); + int (*set_dr)(struct lrw_hw *hw, struct lrw_dr *dr); + int (*start_rx_window)(struct lrw_hw *hw, u32 delay); + int (*set_state)(struct lrw_hw *hw, u8 state); +}; + +struct lrw_hw *lrw_alloc_hw(size_t priv_data_len, struct lrw_operations *ops); +void lrw_free_hw(struct lrw_hw *hw); +int lrw_register_hw(struct lrw_hw *hw); +void lrw_unregister_hw(struct lrw_hw *hw); +void lrw_rx_irqsave(struct lrw_hw *hw, struct sk_buff *skb); +void lrw_xmit_complete(struct lrw_hw *hw, struct sk_buff *skb); + +void lrw_set_deveui(struct lrw_hw *hw, u64 eui); +u64 lrw_get_deveui(struct lrw_hw *hw); +void lrw_set_appeui(struct lrw_hw *hw, u64 eui); +u64 lrw_get_appeui(struct lrw_hw *hw); +void lrw_set_devaddr(struct lrw_hw *hw, u32 eui); +u32 lrw_get_devaddr(struct lrw_hw *hw); + +enum { + LRW_APPKEY, + LRW_NWKSKEY, + LRW_APPSKEY, +}; + +#define LRW_KEY_LEN 16 + +int lrw_set_key(struct lrw_hw *hw, u8 type, u8 *key, size_t key_len); + +#endif