Jorijn van der Graaf
9cd00a65e8
The S3NRN4V (e.g. on the Fairphone 6, SM7635) is an S3FWRN5-family NFC controller that needs different bring-up, selected with a new samsung,s3nrn4v compatible: - It ships with working firmware behind a bootloader protocol this driver does not implement (GET_BOOTINFO times out), so the firmware download step is skipped. Its RF registers are (re)loaded with the proprietary DUAL_OPTION command (the HW and SW register blobs merged into a single stream) instead of the START/SET/STOP_RFREG sequence. - Its reference clock speed is configured with the single-byte FW_CFG form, sent from the ->setup hook (after CORE_RESET, before CORE_INIT). The selector value (0x11) is taken from the vendor configuration for this part; its encoding is not documented. - It gates its XI clock through a CLK_REQ line: the chip drives it high when it needs the clock, notably to synthesise the 13.56 MHz poll carrier. Left always-on, the free-running clock never lets the chip's TX PLL lock on a fresh start and it cannot poll (it falls back to listen only). Service the handshake when a clk-req GPIO is described, gating the clock on it; without one the clock stays always-on. The variant is carried as match data by both the OF and the I2C device id tables so the two match paths agree, and the OF table is now referenced unconditionally for its match data, so drop the of_match_ptr()/__maybe_unused annotations from it. The error policy differs between the two configuration steps on purpose: a clock misconfiguration is fatal (a ->setup failure aborts CORE_INIT), whereas an RF-register update failure is only warned about and bring-up continues, since the chip falls back to the RF registers programmed in its flash and NFC may still work. Unlike the host-endian word read in the legacy rfreg path, the DUAL_OPTION checksum is accumulated with get_unaligned_le32() and emitted little-endian explicitly, so it is correct regardless of CPU endianness. Existing S3FWRN5 / S3FWRN82 setups keep the firmware-download path and the always-on clock, unchanged. Assisted-by: Claude:claude-opus-4-8 Assisted-by: Claude:claude-fable-5 Signed-off-by: Jorijn van der Graaf <jorijnvdgraaf@catcrafts.net>
86 lines
1.9 KiB
C
86 lines
1.9 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
/*
|
|
* NCI based driver for Samsung S3FWRN5 NFC chip
|
|
*
|
|
* Copyright (C) 2015 Samsung Electronics
|
|
* Robert Baldyga <r.baldyga@samsung.com>
|
|
*/
|
|
|
|
#ifndef __LOCAL_S3FWRN5_NCI_H_
|
|
#define __LOCAL_S3FWRN5_NCI_H_
|
|
|
|
#include "s3fwrn5.h"
|
|
|
|
#define NCI_PROP_SET_RFREG 0x22
|
|
|
|
struct nci_prop_set_rfreg_cmd {
|
|
__u8 index;
|
|
__u8 data[252];
|
|
};
|
|
|
|
struct nci_prop_set_rfreg_rsp {
|
|
__u8 status;
|
|
};
|
|
|
|
#define NCI_PROP_START_RFREG 0x26
|
|
|
|
struct nci_prop_start_rfreg_rsp {
|
|
__u8 status;
|
|
};
|
|
|
|
#define NCI_PROP_STOP_RFREG 0x27
|
|
|
|
struct nci_prop_stop_rfreg_cmd {
|
|
__u16 checksum;
|
|
};
|
|
|
|
struct nci_prop_stop_rfreg_rsp {
|
|
__u8 status;
|
|
};
|
|
|
|
#define NCI_PROP_FW_CFG 0x28
|
|
|
|
/*
|
|
* Single-byte FW_CFG payload (clock-speed selector) for the S3NRN4V reference
|
|
* clock. Taken from the vendor configuration for this part (the encoding is
|
|
* not documented).
|
|
*/
|
|
#define NCI_PROP_FW_CFG_CLK_SPEED 0x11
|
|
|
|
struct nci_prop_fw_cfg_cmd {
|
|
__u8 clk_type;
|
|
__u8 clk_speed;
|
|
__u8 clk_req;
|
|
};
|
|
|
|
struct nci_prop_fw_cfg_rsp {
|
|
__u8 status;
|
|
};
|
|
|
|
/*
|
|
* The S3NRN4V updates its RF registers through a single "dual option" command
|
|
* (a sub-OID selects the operation) instead of the START/SET/STOP_RFREG
|
|
* opcodes above, and expects the HW and SW register blobs merged into one
|
|
* stream.
|
|
*/
|
|
#define NCI_PROP_DUAL_OPTION 0x2a
|
|
|
|
#define NCI_PROP_DUAL_SUB_START_UPDATE 0x01
|
|
#define NCI_PROP_DUAL_SUB_SET_OPTION 0x02
|
|
#define NCI_PROP_DUAL_SUB_STOP_UPDATE 0x03
|
|
|
|
#define NCI_PROP_DUAL_SECTION_SIZE 252
|
|
|
|
struct nci_prop_dual_set_option_cmd {
|
|
__u8 sub_oid; /* NCI_PROP_DUAL_SUB_SET_OPTION */
|
|
__u8 index;
|
|
__u8 data[NCI_PROP_DUAL_SECTION_SIZE];
|
|
};
|
|
|
|
extern const struct nci_driver_ops s3fwrn5_nci_prop_ops[5];
|
|
int s3fwrn5_nci_rf_configure(struct s3fwrn5_info *info, const char *fw_name);
|
|
int s3fwrn5_nci_rf_configure_dual(struct s3fwrn5_info *info,
|
|
const char *hw_name, const char *sw_name);
|
|
int s3fwrn5_nci_clk_cfg(struct s3fwrn5_info *info);
|
|
|
|
#endif /* __LOCAL_S3FWRN5_NCI_H_ */
|