blob: 4d3fdbacce380c0ee63127214a0bf6db16c6aa92 [file] [log] [blame]
// Copyright 2020 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <map>
#include <memory>
#include <utility>
#include <base/files/file_path.h>
#include <gtest/gtest_prod.h>
#include "typecd/alt_mode.h"
#include "typecd/peripheral.h"
namespace typecd {
// A partner represents a device which is connected to the host. This
// class is used to maintain the state associated with the partner.
class Partner : public Peripheral {
explicit Partner(const base::FilePath& syspath);
Partner(const Partner&) = delete;
Partner& operator=(const Partner&) = delete;
// Check if a particular alt mode index (as specified by the Type C connector
// class framework) is registered.
bool IsAltModePresent(int index);
bool AddAltMode(const base::FilePath& mode_syspath);
void RemoveAltMode(const base::FilePath& mode_syspath);
// Update the AltMode information based on Type C connector class sysfs.
// A udev event is generated when a new partner altmode is registered; parse
// the data at the "known" locations in sysfs and populate the class data
// structures accordingly.
// Previously added altmodes should be unaffected by this function.
void UpdateAltModesFromSysfs();
// Return the total number of AltModes supported by the partner. If this value
// hasn't been populated yet, the default value is -1, signifying that
// discovery is not yet complete.
int GetNumAltModes() { return num_alt_modes_; }
// Set the total number of AltModes supported by the partner. This value
// should be populated either:
// - From the corresponding file in sysfs
// <or>
// - When an appropriate signal is received from the kernel about completion
// of partner Discovery.
// Since neither of the above have been implemented yet, we can call this
// function explicitly for the sake of unit tests.
void SetNumAltModes(int num_alt_modes) { num_alt_modes_ = num_alt_modes; }
// Return the AltMode with index |index|, and nullptr if such an AltMode
// doesn't exist.
AltMode* GetAltMode(int index);
// A map representing all the alternate modes supported by the partner.
// The key is the index of the alternate mode as determined by the connector
// class sysfs directories that represent them. For example, and alternate
// mode which has the directory
// "/sys/class/typec/port1-partner/port1-partner.0" will use an key of "0".
std::map<int, std::unique_ptr<AltMode>> alt_modes_;
int num_alt_modes_;
} // namespace typecd