Received: by 2002:ad5:474a:0:0:0:0:0 with SMTP id i10csp8300500imu; Tue, 4 Dec 2018 06:19:21 -0800 (PST) X-Google-Smtp-Source: AFSGD/XbNXZxdYNAzIvxJp/+lnESKkuyt6FxMGCvGGt/6msP7E7O2sIAzaPhriDvQmdVrfBgTHtK X-Received: by 2002:a17:902:20b:: with SMTP id 11mr20273096plc.57.1543933161611; Tue, 04 Dec 2018 06:19:21 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1543933161; cv=none; d=google.com; s=arc-20160816; b=EuforRvCEqhBd711XaBGUZjUyfxOFlCdWF63Nhi6Wbi/606WwnmUXj9RljN0g8La+W RMkNTMQQeE8Ba8UALsIlkfjnaRJqYx5jEmD0outybcsEoRu9ppZAJM/IQi0NHRIBBba0 EkKVGdpsROEi9Z0NjdLI1GLH08Jw84x2swW6ZjlMTkN7CCzuaJgjZIOPhBZattp+idDB I8mC05c/x127xOpI9MNJn4qR8s3mmGEO6wRJkp2f2Mijn6O2sTdjqBvUREYhajfv8Bkp QZZ+S8ztryVPa31yWVTQgTXtnTyTaReWmFPmL4Eh5DIlGN9rt9ARyD2oFYSuZOAiIkIU M79A== 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 :dkim-signature; bh=QT/jwpU9ivKbEFe6HNlLtAKOm/2gOedicUVpenMpNWY=; b=qETJF/bQBg2Zmrf7d2KcMs11o6k1hTaP0FG1+KQJqY8NfDw6jfr+Gk3rJs77w5epEF QAS1aOyy6STrJtqzomsrKK5mB78vu8aJVVweGupjMP9z4HsmMEkZHDRSf7elLGgo95ac 8LuDzmzzs+aPmjbO8RF83IGVpqZqXKqBaoETpR5fh5KLNmAn+mkyW/Dli6wXEABLTtfv mkHlPReuSkHUzAggnB8dP3lx06yS8id32jp1R2qWtLusYjc9ZXdn9dxhYerg5g9X2jGT p5vd5i7oE0AMpXlak9QzNjin8WS+duxPtj0mtO7QU/SnZijZM5Nvt65A+NJjov0VRFzB U8hg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@g.ncu.edu.tw header.s=google header.b=eck9SQUY; 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 x9si14460981pgh.12.2018.12.04.06.19.05; Tue, 04 Dec 2018 06:19:21 -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; dkim=pass header.i=@g.ncu.edu.tw header.s=google header.b=eck9SQUY; 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 S1726868AbeLDOQY (ORCPT + 99 others); Tue, 4 Dec 2018 09:16:24 -0500 Received: from mail-pg1-f193.google.com ([209.85.215.193]:45593 "EHLO mail-pg1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726710AbeLDOPj (ORCPT ); Tue, 4 Dec 2018 09:15:39 -0500 Received: by mail-pg1-f193.google.com with SMTP id y4so7414263pgc.12 for ; Tue, 04 Dec 2018 06:15:39 -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=QT/jwpU9ivKbEFe6HNlLtAKOm/2gOedicUVpenMpNWY=; b=eck9SQUYRqWwcMG4f3ZkERiQhM1+bbdR5dLK/Kn6uTChNAQDbmOUD1V9MrkXIlDM/Q kpDcS94Pl2Ups0YlXtwGUSwYcnN41sZp/Cx7RbJkYeBXNxhW7hfrVILQjKlXW1FUsrFf V2OuhFAdQ6DQzVnKZ0F1TEy2fXXi/TJpRwUEQ= 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=QT/jwpU9ivKbEFe6HNlLtAKOm/2gOedicUVpenMpNWY=; b=sQ6C1RdJvJ97u6Q4KwQDBLOEMetffOWuPySVivB8dGznf4iMEv7HmORZyiygZCZE3d cJwaKluma1GGFW0qOTQw0AThsO6gHKzQ+hWETr5UEvRPa7FFed0eg/IiwldNlhg+GZoV zW/ZFskTakPJ9nZWwLximUyuJdS3WWPECZJkyE8iyrTU4hCTZmfG+IzR5yR93oCjEnB8 AqMsiBhwaifDZrlGY8H7h8AzocwHBfIBDiz0KUOUWllK50PXaEv4V9C/g8GKGF/QHl1X Mv5u8a99QGgpC27vJkpXXQFTF7lnub5MylXJGEaKOOZ6zty9TLgUKVfzopKuZzLXB7+7 rE6g== X-Gm-Message-State: AA+aEWYUDr2fXOER5pmD83HfFj2ga3+g2pXksrU0eXfs3M90RBsW1EnQ iToHjx7rtgknM4j1NrvSpVzBeA== X-Received: by 2002:a63:6c48:: with SMTP id h69mr16052195pgc.139.1543932938838; Tue, 04 Dec 2018 06:15:38 -0800 (PST) Received: from starnight.local ([150.116.248.145]) by smtp.gmail.com with ESMTPSA id n66sm36975863pfk.19.2018.12.04.06.15.36 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 04 Dec 2018 06:15:38 -0800 (PST) From: Jian-Hong Pan To: =?UTF-8?q?Andreas=20F=C3=A4rber?= , "David S . Miller" Cc: 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, Stefan Schmidt , Jian-Hong Pan Subject: [PATCH V4 3/6] net: maclorawan: Add maclorawan module declaration Date: Tue, 4 Dec 2018 22:13:40 +0800 Message-Id: <20181204141341.4353-4-starnight@g.ncu.edu.tw> X-Mailer: git-send-email 2.19.2 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add the maclorawan header file for common APIs in the module. Signed-off-by: Jian-Hong Pan --- V2: - Split the LoRaWAN class module patch in V1 into LoRaWAN socket and LoRaWAN Soft MAC modules - Use SPDX license identifiers V4: - Fix typo in comments - Fix by coding style report from scripts/checkpatch.pl net/maclorawan/maclorawan.h | 200 ++++++++++++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) create mode 100644 net/maclorawan/maclorawan.h diff --git a/net/maclorawan/maclorawan.h b/net/maclorawan/maclorawan.h new file mode 100644 index 000000000000..572c26c7cf40 --- /dev/null +++ b/net/maclorawan/maclorawan.h @@ -0,0 +1,200 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later OR BSD-3-Clause */ +/*- + * LoRaWAN soft MAC + * + * Copyright (c) 2018 Jian-Hong, Pan + * + */ + +#ifndef __MAC_LORAWAN_H__ +#define __MAC_LORAWAN_H__ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define LORAWAN_MODULE_NAME "maclorawan" + +/* List the message types of LoRaWAN */ +enum { + LRW_JOIN_REQUEST, + LRW_JOIN_ACCEPT, + LRW_UNCONFIRMED_DATA_UP, + LRW_UNCONFIRMED_DATA_DOWN, + LRW_CONFIRMED_DATA_UP, + LRW_CONFIRMED_DATA_DOWN, + LRW_RFU, + LRW_PROPRIETARY, +}; + +/* List the communication directions */ +enum { + LRW_UPLINK, + LRW_DOWNLINK, +}; + +/* States of LoRaWAN slot timing */ +enum { + LRW_INIT_SS, + LRW_XMITTING_SS, + LRW_XMITTED, + LRW_RX1_SS, + LRW_RX2_SS, + LRW_RXTIMEOUT_SS, + LRW_RXRECEIVED_SS, + LRW_RETRANSMIT_SS, +}; + +#define LRW_MHDR_LEN 1 +#define LRW_FHDR_MAX_LEN 22 +#define LRW_FOPS_MAX_LEN 15 +#define LRW_FPORT_LEN 1 +#define LRW_MIC_LEN 4 + +/** + * lrw_fhdr - Hold the message's basic information of the frame + * + * @mtype: this message's type + * @fctrl: the frame control byte + * @fcnt: this message's frame counter value + * @fopts: this frame's options field + * @fopts_len: the length of the fopts + */ +struct lrw_fhdr { + u8 mtype; + u8 fctrl; + u16 fcnt; + u8 fopts[LRW_FPORT_LEN]; + u8 fopts_len; +}; + +/** + * lrw_session - LoRaWAN session for Class A end device + * + * @lrw_st: points to the belonging lrw_st + * @entry: the entry of the ss_list in lrw_struct + * @devaddr: the LoRaWAN device address of this LoRaWAN hardware + * @fcnt_up: uplink frame counter + * @fcnt_down: downlink frame counter + * @fport: the LoRaWAN data message's port field + * @tx_skb: points to the TX skb, the frame + * @rx_skb: points to the RX skb, the frame + * @tx_fhdr: hold the message's basic information of the TX frame + * @rx_fhdr: hold the message's basic information of the RX frame + * @tx_should_ack: flag for determining the TX which should be acked or not + * @retry: retry times for xmitting failed + * @state: this session's current state + * @state_lock: lock of the session's state + * @timer: timing for this session and the state transition + * @timeout_work: work if waiting acknowledge time out + * @rx_delay1: RX1 delay time in seconds + * @rx_delay2: RX2 delay time in seconds + * @rx1_window: RX1 window opening time in milliseconds + * @rx2_window: RX2 window opening time in milliseconds + * @ack_timeout: time out time for waiting acknowledge in seconds + */ +struct lrw_session { + struct lrw_struct *lrw_st; + struct list_head entry; + + u32 devaddr; + u16 fcnt_up; + u16 fcnt_down; + u8 fport; + struct sk_buff *tx_skb; + struct sk_buff *rx_skb; + struct lrw_fhdr tx_fhdr; + struct lrw_fhdr rx_fhdr; + + u8 tx_should_ack; + u8 retry; + u8 state; + spinlock_t state_lock; /* lock of the session's state */ + + struct timer_list timer; + struct work_struct timeout_work; + unsigned long rx_delay1; + unsigned long rx_delay2; + unsigned long rx1_window; + unsigned long rx2_window; + unsigned long ack_timeout; +}; + +/** + * lrw_struct - The full LoRaWAN hardware to the LoRa device. + * + * @dev: this LoRa device registed in system + * @hw: the LoRa device of this LoRaWAN hardware + * @ops: handle of LoRa operations interfaces + * @rx_skb_list: the list of received frames + * @ss_list: LoRaWAN session list of this LoRaWAN hardware + * @ss_list_lock: lock of the session list + * @_cur_ss: pointer of the current processing session + * @rx_should_ack: represent the current session should be acked or not + * @state: the state of this LoRaWAN hardware + * @app_eui: the LoRaWAN application EUI + * @dev_eui: the LoRaWAN device EUI + * @devaddr: the LoRaWAN device address of this LoRaWAN hardware + * @appky: the Application key + * @nwkskey: the Network session key + * @appskey: the Application session key + * @nwks_shash_tfm: the hash handler for LoRaWAN network session + * @nwks_skc_tfm: the crypto handler for LoRaWAN network session + * @apps_skc_tfm: the crypto handler for LoRaWAN application session + * @fcnt_up: the counter of this LoRaWAN hardware's up frame + * @fcnt_down: the counter of this LoRaWAN hardware's down frame + * @xmit_task: the xmit task for the current LoRaWAN session + * @rx_work: the RX work in workqueue for the current LoRaWAN session + * @ndev: points to the emulating network device + * @_net: the current network namespace of this LoRaWAN hardware + */ +struct lrw_struct { + struct device dev; + struct lrw_hw hw; + struct lrw_operations *ops; + + struct sk_buff_head rx_skb_list; + struct list_head ss_list; + struct mutex ss_list_lock; /* lock of the session list */ + struct lrw_session *_cur_ss; + u8 rx_should_ack; + u8 state; + + u64 app_eui; + u64 dev_eui; + u32 devaddr; + u8 appkey[LRW_KEY_LEN]; + u8 nwkskey[LRW_KEY_LEN]; + u8 appskey[LRW_KEY_LEN]; + struct crypto_shash *nwks_shash_tfm; + struct crypto_sync_skcipher *nwks_skc_tfm; + struct crypto_sync_skcipher *apps_skc_tfm; + + u16 fcnt_up; + u16 fcnt_down; + + struct tasklet_struct xmit_task; + struct work_struct rx_work; + + struct net_device *ndev; + possible_net_t _net; +}; + +#define NETDEV_2_LRW(ndev) ((struct lrw_struct *)netdev_priv(ndev)) + +struct lrw_session *lrw_alloc_ss(struct lrw_struct *lrw_st); +void lrw_free_ss(struct lrw_session *ss); +void lrw_del_ss(struct lrw_session *ss); +int lrw_start_hw(struct lrw_struct *lrw_st); +void lrw_stop_hw(struct lrw_struct *lrw_st); +void lrw_prepare_tx_frame(struct lrw_session *ss); +void lrw_xmit(unsigned long data); +void lrw_rx_work(struct work_struct *work); + +#endif -- 2.19.2