/*

 * Intel(R) Enclosure LED Utilities

 * Copyright (C) 2009-2017 Intel Corporation.

 *

 * This program is free software; you can redistribute it and/or modify it

 * under the terms and conditions of the GNU General Public License,

 * version 2, as published by the Free Software Foundation.

 *

 * This program is distributed in the hope it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for

 * more details.

 *

 * You should have received a copy of the GNU General Public License along with

 * this program; if not, write to the Free Software Foundation, Inc.,

 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.

 *

 */

#ifndef _AHCI_H_INCLUDED_

#define _AHCI_H_INCLUDED_

#include "block.h"

#include "ibpi.h"

/**

 * @brief Gets sysfs path to SATA port.

 *

 * The function returns a path to SATA port in sysfs tree the given block device

 * is connected to.

 *

 * @param[in]      path           Path to block device in sysfs tree.

 *

 * @return Canonical path if successful, otherwise NULL pointer if an error occurred.

 */

char *ahci_get_port_path(const char *path);

/**

 * @brief Sends LED control message using SGPIO.

 *

 * This function visualizes IBPI pattern on LEDs associated with a slot in

 * drive bay. This function is designed to send messaged to AHCI controller

 * only.

 *

 * @param[in]      path           Path in sysfs tree to slot in drive bay.

 * @param[in]      ibpi           IBPI pattern to visualize on LEDs associated

 *                                with the given slot.

 *

 * @return Number of bytes send to controller, -1 means error occurred and

 *         errno has additional error information.

 */

int ahci_sgpio_write(struct block_device *path, enum ibpi_pattern ibpi);

#endif				/* _AHCI_H_INCLUDED_ */