Commit 9ad28ba1 authored by Tom Rix's avatar Tom Rix Committed by Gregory Greenman
Browse files

wifi: iwlwifi: mei: clean up comments 



SPDX
*.h use /* */ style comments

Spelling replacements
commnunication to communication
adsress to address
procotol to protocol
addtional to additional
kown to know
negotiaion to negotiation
mssage to message

Signed-off-by: default avatarTom Rix <trix@redhat.com>
Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarGregory Greenman <gregory.greenman@intel.com>
Link: https://lore.kernel.org/r/20221205102808.f1ff5aff270b.Ie4ba3f980a35455ed95e7c0cae854231fccc89e2@changeid
parent b201944a

drivers/net/wireless/intel/iwlwifi/mei/iwl-mei.h

+3 −3
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/* SPDX-License-Identifier: GPL-2.0-only */

/*

 * Copyright (C) 2021 Intel Corporation

 */
@@ -13,7 +13,7 @@ 
/**

 * DOC: Introduction

 *

 * iwlmei is the kernel module that is in charge of the commnunication between

 * iwlmei is the kernel module that is in charge of the communication between

 * the iwlwifi driver and the CSME firmware's WLAN driver. This communication

 * uses the SAP protocol defined in another file.

 * iwlwifi can request or release ownership on the WiFi device through iwlmei.
@@ -348,7 +348,7 @@ void iwl_mei_set_rfkill_state(bool hw_rfkill, bool sw_rfkill); 
/**

 * iwl_mei_set_nic_info() - set mac address

 * @mac_address: mac address to set

 * @nvm_address: NVM mac adsress to set

 * @nvm_address: NVM mac address to set

 *

 * This function must be called upon mac address change.

 */

drivers/net/wireless/intel/iwlwifi/mei/main.c

+1 −1
Original line number Diff line number Diff line
@@ -1963,7 +1963,7 @@ static int iwl_mei_probe(struct mei_cl_device *cldev, 
	iwl_mei_dbgfs_register(mei);



	/*

	 * We now have a Rx function in place, start the SAP procotol

	 * We now have a Rx function in place, start the SAP protocol

	 * we expect to get the SAP_ME_MSG_START_OK response later on.

	 */

	mutex_lock(&iwl_mei_mutex);

drivers/net/wireless/intel/iwlwifi/mei/sap.h

+5 −5
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/* SPDX-License-Identifier: GPL-2.0-only */

/*

 * Copyright (C) 2021 - 2022 Intel Corporation

 */
@@ -25,7 +25,7 @@ 
 *

 * Since this messaging system cannot support high amounts of

 * traffic, iwlwifi and the CSME firmware's WLAN driver have an

 * addtional communication pipe to exchange information. The body

 * additional communication pipe to exchange information. The body

 * of the message is copied to a shared area and the message that

 * goes over the ME interface just signals the other side

 * that a new message is waiting in the shared area. The ME
@@ -55,7 +55,7 @@ 
/**

 * DOC: Host and driver state messages

 *

 * In order to let CSME konw about the host state and the host driver state,

 * In order to let CSME know about the host state and the host driver state,

 * the host sends messages that let CSME know about the host's state.

 * When the host driver is loaded, the host sends %SAP_MSG_NOTIF_WIFIDR_UP.

 * When the host driver is unloaded, the host sends %SAP_MSG_NOTIF_WIFIDR_DOWN.
@@ -76,7 +76,7 @@ 
 * DOC: Ownership

 *

 * The device can be controlled either by the CSME firmware or

 * by the host driver: iwlwifi. There is a negotiaion between

 * by the host driver: iwlwifi. There is a negotiation between

 * those two entities to determine who controls (or owns) the

 * device. Since the CSME can control the device even when the

 * OS is not working or even missing, the CSME can request the
@@ -136,7 +136,7 @@ enum iwl_sap_me_msg_id { 
 * struct iwl_sap_me_msg_hdr - the header of the ME message

 * @type: the type of the message, see &enum iwl_sap_me_msg_id.

 * @seq_num: a sequence number used for debug only.

 * @len: the length of the mssage.

 * @len: the length of the message.

 */

struct iwl_sap_me_msg_hdr {

	__le32 type;

drivers/net/wireless/intel/iwlwifi/mei/trace-data.h

+1 −1
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/* SPDX-License-Identifier: GPL-2.0-only */

/*

 * Copyright(c) 2021        Intel Corporation

 */

drivers/net/wireless/intel/iwlwifi/mei/trace.h

+1 −1
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/* SPDX-License-Identifier: GPL-2.0-only */

/*

 * Copyright(c) 2021        Intel Corporation

 */