system/dev/light-sensor/ams-light/tcs3400.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#pragma once

#include <ddk/protocol/gpio.h>
#include <ddk/protocol/i2c.h>

#include <ddktl/device.h>
#include <ddktl/protocol/hidbus.h>

#include <fbl/mutex.h>

#include <hid/ambient-light.h>

#include <lib/zx/interrupt.h>

#include <zircon/thread_annotations.h>

namespace tcs {

class Tcs3400Device;
using DeviceType = ddk::Device<Tcs3400Device, ddk::Unbindable, ddk::Readable>;

// Note: the TCS-3400 device is connected via i2c and is not a HID
// device.  This driver reads a collection of data from the data and
// parses it into a message which will be sent up the stack.  This message
// complies with a HID descriptor that was manually scripted (i.e. - not
// reported by the device iteself).
class Tcs3400Device : public DeviceType,
                      public ddk::HidbusProtocol<Tcs3400Device, ddk::base_protocol> {
public:
    Tcs3400Device(zx_device_t* device)
        : DeviceType(device) {}

    zx_status_t Bind();

    // Methods required by the ddk mixins
    zx_status_t DdkRead(void* buf, size_t count, zx_off_t off, size_t* actual);

    zx_status_t HidbusStart(const hidbus_ifc_t* ifc) TA_EXCL(client_input_lock_);
    zx_status_t HidbusQuery(uint32_t options, hid_info_t* info);
    void HidbusStop();
    zx_status_t HidbusGetDescriptor(uint8_t desc_type, void** data, size_t* len);
    zx_status_t HidbusGetReport(uint8_t rpt_type, uint8_t rpt_id, void* data,
                                size_t len, size_t* out_len)
        TA_EXCL(client_input_lock_, feature_lock_);
    zx_status_t HidbusSetReport(uint8_t rpt_type, uint8_t rpt_id, const void* data,
                                size_t len) TA_EXCL(feature_lock_);
    zx_status_t HidbusGetIdle(uint8_t rpt_id, uint8_t* duration);
    zx_status_t HidbusSetIdle(uint8_t rpt_id, uint8_t duration);
    zx_status_t HidbusGetProtocol(uint8_t* protocol);
    zx_status_t HidbusSetProtocol(uint8_t protocol);

    void DdkUnbind();
    void DdkRelease();

private:
    i2c_protocol_t i2c_ TA_GUARDED(i2c_lock_);
    gpio_protocol_t gpio_ TA_GUARDED(i2c_lock_);
    zx::interrupt irq_;
    thrd_t thread_;
    zx_handle_t port_handle_;
    fbl::Mutex client_input_lock_ TA_ACQ_BEFORE(i2c_lock_);
    fbl::Mutex feature_lock_;
    fbl::Mutex i2c_lock_;
    ddk::HidbusIfcClient client_ TA_GUARDED(client_input_lock_);
    ambient_light_input_rpt_t input_rpt_ TA_GUARDED(client_input_lock_);
    ambient_light_feature_rpt_t feature_rpt_ TA_GUARDED(feature_lock_);
    zx_status_t FillInputRpt() TA_REQ(client_input_lock_);
    int Thread();
    void ShutDown() TA_EXCL(client_input_lock_);
};
}