===========================================================
             Broadcom NFC Daemon for Linux
===========================================================


================
DESCRIPTION
================

This package is a Linux based package to install Broadcom NFC daemon.  The NFC
daemon runs and NFC stack needed to initialize and keep the state of the NFC
controller of the CV device.  The sole purpose of this NFC stack is to enable
the Contactless CCID interface.

It is assumed higher level software such as PCSC Lite will be used in conjunction
with the NFC daemon.

The utility must be run with "sudo".

================
REQUIREMENTS
================

The utility should be run on Dell machines running Ubuntu 24.04

The utility depends on libusb-1.0-0 library to be installed.
The package should have been installed on your Ubuntu 24.04.
Issue "dpkg -l | grep libusb-1.0-0" to check if the package is installed. 
If it's not installed, issue "sudo apt install libusb-1.0-0" to install it.

================
GETTING STARTED
================

The installation package
------------------------
The installation package is named brcm_linux_nfc_<version>.tgz

Install the package
-------------------
Use below commands to extract and install the Broadcom package:
  sudo tar -xzf brcm_linux_nfc_<version>.tgz
  sudo ./install.sh

After the package is installed, following directories/files will be installed on system:

/etc/systemd/system/broadcom-nfc.service
/lib/systemd/system-sleep/bcmnfcd-control.sh
/usr/lib/broadcom-nfc/bcmnfcd.bin
/usr/lib/broadcom-nfc/bcmnfcd.conf

Rebooting the computer post installation is not necessary.

NOTE: this package assumes that the CV firmware will be upgraded by another process.

NOTE: If the installation procedure detects an existing bcmnfcd.conf file, it will be
overwritten with a newer version.  The old version is archived to
/usr/lib/broadcom-nfc/bcmnfcd.conf.save.

By default, logging is sent to /var/log/syslog.

How to remove the installed package
-----------------------------------
Issue this command to remove it:
sudo ./rm.sh


