Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 | /*
* Copyright (c) 2019 Intel Corporation.
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Public APIs for eSPI driver
*/
#ifndef ZEPHYR_INCLUDE_ESPI_H_
#define ZEPHYR_INCLUDE_ESPI_H_
#include <sys/__assert.h>
#include <zephyr/types.h>
#include <device.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief eSPI Driver APIs
* @defgroup espi_interface ESPI Driver APIs
* @ingroup io_interfaces
* @{
*/
/**
* @brief eSPI I/O mode capabilities
*/
enum espi_io_mode {
ESPI_IO_MODE_SINGLE_LINE = BIT(0),
ESPI_IO_MODE_DUAL_LINES = BIT(1),
ESPI_IO_MODE_QUAD_LINES = BIT(2),
};
/**
*+----------------------------------------------------------------------+
*| |
*| eSPI host +-------------+ |
*| +-----------+ | Power | +----------+ |
*| |Out of band| | management | | GPIO | |
*| +------------+ |processor | | controller | | sources | |
*| | SPI flash | +-----------+ +-------------+ +----------+ |
*| | controller | | | | |
*| +------------+ | | | |
*| | | | +--------+ +---------------+ |
*| | | | | | |
*| | | +-----+ +--------+ +----------+ +----v-----+ |
*| | | | | LPC | | Tunneled | | Tunneled | |
*| | | | | bridge | | SMBus | | GPIO | |
*| | | | +--------+ +----------+ +----------+ |
*| | | | | | | |
*| | | | ------+ | | |
*| | | | | | | |
*| | | +------v-----+ +---v-------v-------------v----+ |
*| | | | eSPI Flash | | eSPI protocol block | |
*| | | | access +--->+ | |
*| | | +------------+ +------------------------------+ |
*| | | | |
*| | +-----------+ | |
*| | v v |
*| | XXXXXXXXXXXXXXXXXXXXXXX |
*| | XXXXXXXXXXXXXXXXXXXXX |
*| | XXXXXXXXXXXXXXXXXXX |
*+----------------------------------------------------------------------+
* | |
* v +-----------------+
* +---------+ | | | | | |
* | Flash | | | | | | |
* +---------+ | + + + + | eSPI bus
* | CH0 CH1 CH2 CH3 | (logical channels)
* | + + + + |
* | | | | | |
* +-----------------+
* |
*+-----------------------------------------------------------------------+
*| eSPI slave |
*| |
*| CH0 | CH1 | CH2 | CH3 |
*| eSPI endpoint | VWIRE | OOB | Flash |
*+-----------------------------------------------------------------------+
*
*/
/**
* @brief eSPI channel.
*
* Identifies each eSPI logical channel supported by eSPI controller
* Each channel allows independent traffic, but the assignment of channel
* type to channel number is fixed.
*
* Note that generic commands are not associated with any channel, so traffic
* over eSPI can occur if all channels are disabled or not ready
*/
enum espi_channel {
ESPI_CHANNEL_PERIPHERAL = BIT(0),
ESPI_CHANNEL_VWIRE = BIT(1),
ESPI_CHANNEL_OOB = BIT(2),
ESPI_CHANNEL_FLASH = BIT(3),
};
/**
* @brief eSPI bus event.
*
* eSPI bus event to indicate events for which user can register callbacks
*/
enum espi_bus_event {
ESPI_BUS_RESET = BIT(0),
ESPI_BUS_EVENT_CHANNEL_READY = BIT(1),
ESPI_BUS_EVENT_VWIRE_RECEIVED = BIT(2),
ESPI_BUS_EVENT_OOB_RECEIVED = BIT(3),
ESPI_BUS_PERIPHERAL_NOTIFICATION = BIT(4),
};
/**
* @cond INTERNAL_HIDDEN
*
*/
#define ESPI_PERIPHERAL_INDEX_0 0ul
#define ESPI_PERIPHERAL_INDEX_1 1ul
#define ESPI_PERIPHERAL_INDEX_2 2ul
#define ESPI_SLAVE_TO_MASTER 0ul
#define ESPI_MASTER_TO_SLAVE 1ul
#define ESPI_VWIRE_SRC_ID0 0ul
#define ESPI_VWIRE_SRC_ID1 1ul
#define ESPI_VWIRE_SRC_ID2 2ul
#define ESPI_VWIRE_SRC_ID3 3ul
#define ESPI_VWIRE_SRC_ID_MAX 4ul
#define ESPI_PERIPHERAL_NODATA 0ul
#define E8042_START_OPCODE 0x50
#define E8042_MAX_OPCODE 0x5F
/** @endcond */
/**
* @brief eSPI peripheral notification type.
*
* eSPI peripheral notification event details to indicate which peripheral
* trigger the eSPI callback
*/
enum espi_virtual_peripheral {
ESPI_PERIPHERAL_UART,
ESPI_PERIPHERAL_8042_KBC,
ESPI_PERIPHERAL_HOST_IO,
ESPI_PERIPHERAL_DEBUG_PORT80
};
/**
* @brief eSPI cycle types supported over eSPI peripheral channel
*/
enum espi_cycle_type {
ESPI_CYCLE_MEMORY_READ32,
ESPI_CYCLE_MEMORY_READ64,
ESPI_CYCLE_MEMORY_WRITE32,
ESPI_CYCLE_MEMORY_WRITE64,
ESPI_CYCLE_MESSAGE_NODATA,
ESPI_CYCLE_MESSAGE_DATA,
ESPI_CYCLE_OK_COMPLETION_NODATA,
ESPI_CYCLE_OKCOMPLETION_DATA,
ESPI_CYCLE_NOK_COMPLETION_NODATA,
};
/**
* @brief eSPI system platform signals that can be send or receive through
* virtual wire channel
*/
enum espi_vwire_signal {
/* Virtual wires that can only be send from master to slave */
ESPI_VWIRE_SIGNAL_SLP_S3,
ESPI_VWIRE_SIGNAL_SLP_S4,
ESPI_VWIRE_SIGNAL_SLP_S5,
ESPI_VWIRE_SIGNAL_OOB_RST_WARN,
ESPI_VWIRE_SIGNAL_PLTRST,
ESPI_VWIRE_SIGNAL_SUS_STAT,
ESPI_VWIRE_SIGNAL_NMIOUT,
ESPI_VWIRE_SIGNAL_SMIOUT,
ESPI_VWIRE_SIGNAL_HOST_RST_WARN,
ESPI_VWIRE_SIGNAL_SLP_A,
ESPI_VWIRE_SIGNAL_SUS_PWRDN_ACK,
ESPI_VWIRE_SIGNAL_SUS_WARN,
ESPI_VWIRE_SIGNAL_SLP_WLAN,
ESPI_VWIRE_SIGNAL_SLP_LAN,
ESPI_VWIRE_SIGNAL_HOST_C10,
ESPI_VWIRE_SIGNAL_DNX_WARN,
/* Virtual wires that can only be send from slave to master */
ESPI_VWIRE_SIGNAL_PME,
ESPI_VWIRE_SIGNAL_WAKE,
ESPI_VWIRE_SIGNAL_OOB_RST_ACK,
ESPI_VWIRE_SIGNAL_SLV_BOOT_STS,
ESPI_VWIRE_SIGNAL_ERR_NON_FATAL,
ESPI_VWIRE_SIGNAL_ERR_FATAL,
ESPI_VWIRE_SIGNAL_SLV_BOOT_DONE,
ESPI_VWIRE_SIGNAL_HOST_RST_ACK,
ESPI_VWIRE_SIGNAL_RST_CPU_INIT,
/* System management interrupt */
ESPI_VWIRE_SIGNAL_SMI,
/* System control interrupt */
ESPI_VWIRE_SIGNAL_SCI,
ESPI_VWIRE_SIGNAL_DNX_ACK,
ESPI_VWIRE_SIGNAL_SUS_ACK,
};
/* eSPI LPC peripherals. */
enum lpc_peripheral_opcode {
/* Read transactions */
E8042_OBF_HAS_CHAR = 0x50,
E8042_IBF_HAS_CHAR,
/* Write transactions */
E8042_WRITE_KB_CHAR,
E8042_WRITE_MB_CHAR,
/* Write transactions without input parameters */
E8042_RESUME_IRQ,
E8042_PAUSE_IRQ,
E8042_CLEAR_OBF,
};
/**
* @brief eSPI event
*/
struct espi_event {
/** Event type */
enum espi_bus_event evt_type;
/** Additional details for bus event type */
u32_t evt_details;
/** Data associated to the event */
u32_t evt_data;
};
/**
* @brief eSPI bus configuration parameters
*/
struct espi_cfg {
/** Supported I/O mode */
enum espi_io_mode io_caps;
/** Supported channels */
enum espi_channel channel_caps;
/** Maximum supported frequency in MHz */
u8_t max_freq;
};
/**
* @brief eSPI peripheral request packet format
*/
struct espi_request_packet {
enum espi_cycle_type cycle_type;
u8_t tag;
u16_t len;
u32_t address;
u8_t *data;
};
/**
* @brief eSPI out-of-band transaction packet format
*/
struct espi_oob_packet {
u8_t *buf;
u16_t len;
};
/**
* @brief eSPI flash transactions packet format
*/
struct espi_flash_packet {
u8_t *buf;
u32_t flash_addr;
u16_t len;
};
struct espi_callback;
/**
* @typedef espi_callback_handler_t
* @brief Define the application callback handler function signature.
*
* @param dev Device struct for the eSPI device.
* @param cb Original struct espi_callback owning this handler.
* @param espi_evt event details that trigger the callback handler.
*
*/
typedef void (*espi_callback_handler_t) (struct device *dev,
struct espi_callback *cb,
struct espi_event espi_evt);
/**
* @cond INTERNAL_HIDDEN
*
* Used to register a callback in the driver instance callback list.
* As many callbacks as needed can be added as long as each of them
* are unique pointers of struct espi_callback.
* Beware such structure should not be allocated on stack.
*
* Note: To help setting it, see espi_init_callback() below
*/
struct espi_callback {
/** This is meant to be used in the driver only */
sys_snode_t node;
/** Actual callback function being called when relevant */
espi_callback_handler_t handler;
/** An event which user is interested in, if 0 the callback
* will never be called. Such evt_mask can be modified whenever
* necessary by the owner, and thus will affect the handler being
* called or not.
*/
enum espi_bus_event evt_type;
};
/** @endcond */
/**
* @cond INTERNAL_HIDDEN
*
* eSPI driver API definition and system call entry points
*
* (Internal use only.)
*/
typedef int (*espi_api_config)(struct device *dev, struct espi_cfg *cfg);
typedef bool (*espi_api_get_channel_status)(struct device *dev,
enum espi_channel ch);
/* Logical Channel 0 APIs */
typedef int (*espi_api_read_request)(struct device *dev,
struct espi_request_packet);
typedef int (*espi_api_write_request)(struct device *dev,
struct espi_request_packet);
typedef int (*espi_api_lpc_read_request)(struct device *dev,
enum lpc_peripheral_opcode op, u32_t *data);
typedef int (*espi_api_lpc_write_request)(struct device *dev,
enum lpc_peripheral_opcode op, u32_t *data);
/* Logical Channel 1 APIs */
typedef int (*espi_api_send_vwire)(struct device *dev,
enum espi_vwire_signal vw,
u8_t level);
typedef int (*espi_api_receive_vwire)(struct device *dev,
enum espi_vwire_signal vw,
u8_t *level);
/* Logical Channel 2 APIs */
typedef int (*espi_api_send_oob)(struct device *dev,
struct espi_oob_packet);
typedef int (*espi_api_receive_oob)(struct device *dev,
struct espi_oob_packet);
/* Logical Channel 3 APIs */
typedef int (*espi_api_flash_read)(struct device *dev,
struct espi_flash_packet);
typedef int (*espi_api_flash_write)(struct device *dev,
struct espi_flash_packet);
typedef int (*espi_api_flash_erase)(struct device *dev,
struct espi_flash_packet);
/* Callbacks and traffic intercept */
typedef int (*espi_api_manage_callback)(struct device *dev,
struct espi_callback *callback,
bool set);
struct espi_driver_api {
espi_api_config config;
espi_api_get_channel_status get_channel_status;
espi_api_read_request read_request;
espi_api_write_request write_request;
espi_api_lpc_read_request read_lpc_request;
espi_api_lpc_write_request write_lpc_request;
espi_api_send_vwire send_vwire;
espi_api_receive_vwire receive_vwire;
espi_api_send_oob send_oob;
espi_api_receive_oob receive_oob;
espi_api_flash_read flash_read;
espi_api_flash_write flash_write;
espi_api_flash_erase flash_erase;
espi_api_manage_callback manage_callback;
};
/**
* @endcond
*/
/**
* @brief Configure operation of a eSPI controller.
*
* This routine provides a generic interface to override eSPI controller
* capabilities.
*
* If this eSPI controller is acting as slave, the values set here
* will be discovered as part through the GET_CONFIGURATION command
* issued by the eSPI master during initialization.
*
* If this eSPI controller is acting as master, the values set here
* will be used by eSPI master to determine minimum common capabilities with
* eSPI slave then send via SET_CONFIGURATION command.
*
* +--------+ +---------+ +------+ +---------+ +---------+
* | eSPI | | eSPI | | eSPI | | eSPI | | eSPI |
* | slave | | driver | | bus | | driver | | host |
* +--------+ +---------+ +------+ +---------+ +---------+
* | | | | |
* | espi_config | Set eSPI | Set eSPI | espi_config |
* +--------------+ ctrl regs | cap ctrl reg| +-----------+
* | +-------+ | +--------+ |
* | |<------+ | +------->| |
* | | | | |
* | | | | |
* | | | GET_CONFIGURATION | |
* | | +<------------------+ |
* | |<-----------| | |
* | | eSPI caps | | |
* | |----------->+ response | |
* | | |------------------>+ |
* | | | | |
* | | | SET_CONFIGURATION | |
* | | +<------------------+ |
* | | | accept | |
* | | +------------------>+ |
* + + + + +
*
* @param dev Pointer to the device structure for the driver instance.
* @param cfg the device runtime configuration for the eSPI controller.
*
* @retval 0 If successful.
* @retval -EIO General input / output error, failed to configure device.
* @retval -EINVAL invalid capabilities, failed to configure device.
* @retval -ENOTSUP capability not supported by eSPI slave.
*/
__syscall int espi_config(struct device *dev, struct espi_cfg *cfg);
static inline int z_impl_espi_config(struct device *dev,
struct espi_cfg *cfg)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
return api->config(dev, cfg);
}
/**
* @brief Query to see if it a channel is ready.
*
* This routine allows to check if logical channel is ready before use.
* Note that queries for channels not supported will always return false.
*
* @param dev Pointer to the device structure for the driver instance.
* @param ch the eSPI channel for which status is to be retrieved.
*
* @retval true If eSPI channel is ready.
* @retval false otherwise.
*/
__syscall bool espi_get_channel_status(struct device *dev,
enum espi_channel ch);
static inline bool z_impl_espi_get_channel_status(struct device *dev,
enum espi_channel ch)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
return api->get_channel_status(dev, ch);
}
/**
* @brief Sends memory, I/O or message read request over eSPI.
*
* This routines provides a generic interface to send a read request packet.
*
* @param dev Pointer to the device structure for the driver instance.
* @param req Structure representing a memory, I/O or message read request.
*
* @retval 0 If successful.
* @retval -ENOTSUP if eSPI controller doesn't support raw packets and instead
* low memory transactions are handled by controller hardware directly.
* @retval -EIO General input / output error, failed to send over the bus.
*/
__syscall int espi_read_request(struct device *dev,
struct espi_request_packet req);
static inline int z_impl_espi_read_request(struct device *dev,
struct espi_request_packet req)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->read_request) {
return -ENOTSUP;
}
return api->read_request(dev, req);
}
/**
* @brief Sends memory, I/O or message write request over eSPI.
*
* This routines provides a generic interface to send a write request packet.
*
* @param dev Pointer to the device structure for the driver instance.
* @param req Structure representing a memory, I/O or message write request.
*
* @retval 0 If successful.
* @retval -ENOTSUP if eSPI controller doesn't support raw packets and instead
* low memory transactions are handled by controller hardware directly.
* @retval -EINVAL General input / output error, failed to send over the bus.
*/
__syscall int espi_write_request(struct device *dev,
struct espi_request_packet req);
static inline int z_impl_espi_write_request(struct device *dev,
struct espi_request_packet req)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->write_request) {
return -ENOTSUP;
}
return api->write_request(dev, req);
}
/**
* @brief Reads SOC data from a LPC peripheral with information
* updated over eSPI.
*
* This routine provides a generic interface to read a block whose
* information was updated by an eSPI transaction. Reading may trigger
* a transaction. The eSPI packet is assembled by the HW block.
*
* @param dev Pointer to the device structure for the driver instance.
* @param op Enum representing opcode for peripheral type and read request.
* @param data Parameter to be read from to the LPC peripheral.
*
* @retval 0 If successful.
* @retval -ENOTSUP if eSPI peripheral is off or not supported.
* @retval -EINVAL for unimplemented lpc opcode, but in range.
*/
__syscall int espi_read_lpc_request(struct device *dev,
enum lpc_peripheral_opcode op, u32_t *data);
static inline int z_impl_espi_read_lpc_request(struct device *dev,
enum lpc_peripheral_opcode op,
u32_t *data)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->read_lpc_request) {
return -ENOTSUP;
}
return api->read_lpc_request(dev, op, data);
}
/**
* @brief Writes data to a LPC peripheral which generates an eSPI transaction.
*
* This routine provides a generic interface to write data to a block which
* triggers an eSPI transaction. The eSPI packet is assembled by the HW
* block.
*
* @param dev Pointer to the device structure for the driver instance.
* @param op Enum representing an opcode for peripheral type and write request.
* @param data Represents the parameter passed to the LPC peripheral.
*
* @retval 0 If successful.
* @retval -ENOTSUP if eSPI peripheral is off or not supported.
* @retval -EINVAL for unimplemented lpc opcode, but in range.
*/
__syscall int espi_write_lpc_request(struct device *dev,
enum lpc_peripheral_opcode op,
u32_t *data);
static inline int z_impl_espi_write_lpc_request(struct device *dev,
enum lpc_peripheral_opcode op,
u32_t *data)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->write_lpc_request) {
return -ENOTSUP;
}
return api->write_lpc_request(dev, op, data);
}
/**
* @brief Sends system/platform signal as a virtual wire packet.
*
* This routines provides a generic interface to send a virtual wire packet
* from slave to master.
*
* @param dev Pointer to the device structure for the driver instance.
* @param signal The signal to be send to eSPI master.
* @param level The level of signal requested LOW or HIGH.
*
* @retval 0 If successful.
* @retval -EIO General input / output error, failed to send over the bus.
*/
__syscall int espi_send_vwire(struct device *dev,
enum espi_vwire_signal signal,
u8_t level);
static inline int z_impl_espi_send_vwire(struct device *dev,
enum espi_vwire_signal signal,
u8_t level)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
return api->send_vwire(dev, signal, level);
}
/**
* @brief Retrieves level status for a signal encapsulated in a virtual wire.
*
* This routines provides a generic interface to request a virtual wire packet
* from eSPI master and retrieve the signal level.
*
* @param dev Pointer to the device structure for the driver instance.
* @param signal the signal to be requested from eSPI master.
* @param level the level of signal requested 0b LOW, 1b HIGH.
*
* @retval -EIO General input / output error, failed request to master.
*/
__syscall int espi_receive_vwire(struct device *dev,
enum espi_vwire_signal signal,
u8_t *level);
static inline int z_impl_espi_receive_vwire(struct device *dev,
enum espi_vwire_signal signal,
u8_t *level)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
return api->receive_vwire(dev, signal, level);
}
/**
* @brief Sends SMBus transaction (out-of-band) packet over eSPI bus.
*
* This routines provides an interface to encapsulate a SMBus transaction
* and send into packet over eSPI bus
*
* @param dev Pointer to the device structure for the driver instance.
* @param pckt the packet representation of SMBus transaction.
*
* @retval -EIO General input / output error, failed request to master.
*/
__syscall int espi_send_oob(struct device *dev, struct espi_oob_packet pckt);
static inline int z_impl_espi_send_oob(struct device *dev,
struct espi_oob_packet pckt)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->send_oob) {
return -ENOTSUP;
}
return api->send_oob(dev, pckt);
}
/**
* @brief Receives SMBus transaction (out-of-band) packet from eSPI bus.
*
* This routines provides an interface to receive and decoded a SMBus
* transaction from eSPI bus
*
* @param dev Pointer to the device structure for the driver instance.
* @param pckt the packet representation of SMBus transaction.
*
* @retval -EIO General input / output error, failed request to master.
*/
__syscall int espi_receive_oob(struct device *dev,
struct espi_oob_packet pckt);
static inline int z_impl_espi_receive_oob(struct device *dev,
struct espi_oob_packet pckt)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->receive_oob) {
return -ENOTSUP;
}
return api->receive_oob(dev, pckt);
}
/**
* @brief Sends a read request packet for shared flash.
*
* This routines provides an interface to send a request to read the flash
* component shared between the eSPI master and eSPI slaves.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pckt the representation of read flash transaction.
*
* @retval -ENOTSUP eSPI flash logical channel transactions not supported.
* @retval -EBUSY eSPI flash channel is not ready or disabled by master.
* @retval -EIO General input / output error, failed request to master.
*/
__syscall int espi_read_flash(struct device *dev,
struct espi_flash_packet pckt);
static inline int z_impl_espi_flash_read(struct device *dev,
struct espi_flash_packet pckt)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->flash_read) {
return -ENOTSUP;
}
return api->flash_read(dev, pckt);
}
/**
* @brief Sends a write request packet for shared flash.
*
* This routines provides an interface to send a request to write to the flash
* components shared between the eSPI master and eSPI slaves.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pckt the representation of write flash transaction.
*
* @retval -ENOTSUP eSPI flash logical channel transactions not supported.
* @retval -EBUSY eSPI flash channel is not ready or disabled by master.
* @retval -EIO General input / output error, failed request to master.
*/
__syscall int espi_write_flash(struct device *dev,
struct espi_flash_packet pckt);
static inline int z_impl_espi_flash_write(struct device *dev,
struct espi_flash_packet pckt)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->flash_write) {
return -ENOTSUP;
}
return api->flash_write(dev, pckt);
}
/**
* @brief Sends a write request packet for shared flash.
*
* This routines provides an interface to send a request to write to the flash
* components shared between the eSPI master and eSPI slaves.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pckt the representation of write flash transaction.
*
* @retval -ENOTSUP eSPI flash logical channel transactions not supported.
* @retval -EBUSY eSPI flash channel is not ready or disabled by master.
* @retval -EIO General input / output error, failed request to master.
*/
__syscall int espi_flash_erase(struct device *dev,
struct espi_flash_packet pckt);
static inline int z_impl_espi_flash_erase(struct device *dev,
struct espi_flash_packet pckt)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->flash_erase) {
return -ENOTSUP;
}
return api->flash_erase(dev, pckt);
}
/**
* Callback model
*
*+-------+ +-------------+ +------+ +---------+
*| App | | eSPI driver | | HW | |eSPI Host|
*+---+---+ +-------+-----+ +---+--+ +----+----+
* | | | |
* | espi_init_callback | | |
* +----------------------------> | | |
* | espi_add_callback | |
* +----------------------------->+ |
* | | | eSPI reset | eSPI host
* | | IRQ +<------------+ resets the
* | | <-----------+ | bus
* | | | |
* | | Processed | |
* | | within the | |
* | | driver | |
* | | | |
* | | | VW CH ready| eSPI host
* | | IRQ +<------------+ enables VW
* | | <-----------+ | channel
* | | | |
* | | Processed | |
* | | within the | |
* | | driver | |
* | | | |
* | | | Memory I/O | Peripheral
* | | <-------------+ event
* | +<------------+ |
* +<-----------------------------+ callback | |
* | Report peripheral event | | |
* | and data for the event | | |
* | | | |
* | | | SLP_S5 | eSPI host
* | | <-------------+ send VWire
* | +<------------+ |
* +<-----------------------------+ callback | |
* | App enables/configures | | |
* | discrete regulator | | |
* | | | |
* | espi_send_vwire_signal | | |
* +------------------------------>------------>|------------>|
* | | | |
* | | | HOST_RST | eSPI host
* | | <-------------+ send VWire
* | +<------------+ |
* +<-----------------------------+ callback | |
* | App reset host-related | | |
* | data structures | | |
* | | | |
* | | | C10 | eSPI host
* | | +<------------+ send VWire
* | <-------------+ |
* <------------------------------+ | |
* | App executes | | |
* + power mgmt policy | | |
*/
/**
* @brief Helper to initialize a struct espi_callback properly.
*
* @param callback A valid Application's callback structure pointer.
* @param handler A valid handler function pointer.
* @param evt_type indicates the eSPI event relevant for the handler.
* for VWIRE_RECEIVED event the data will indicate the new level asserted
*/
static inline void espi_init_callback(struct espi_callback *callback,
espi_callback_handler_t handler,
enum espi_bus_event evt_type)
{
__ASSERT(callback, "Callback pointer should not be NULL");
__ASSERT(handler, "Callback handler pointer should not be NULL");
callback->handler = handler;
callback->evt_type = evt_type;
}
/**
* @brief Add an application callback.
* @param dev Pointer to the device structure for the driver instance.
* @param callback A valid Application's callback structure pointer.
* @return 0 if successful, negative errno code on failure.
*
* @note Callbacks may be added to the device from within a callback
* handler invocation, but whether they are invoked for the current
* eSPI event is not specified.
*
* Note: enables to add as many callback as needed on the same device.
*/
static inline int espi_add_callback(struct device *dev,
struct espi_callback *callback)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->manage_callback) {
return -ENOTSUP;
}
return api->manage_callback(dev, callback, true);
}
/**
* @brief Remove an application callback.
* @param dev Pointer to the device structure for the driver instance.
* @param callback A valid application's callback structure pointer.
* @return 0 if successful, negative errno code on failure.
*
* @warning It is explicitly permitted, within a callback handler, to
* remove the registration for the callback that is running, i.e. @p
* callback. Attempts to remove other registrations on the same
* device may result in undefined behavior, including failure to
* invoke callbacks that remain registered and unintended invocation
* of removed callbacks.
*
* Note: enables to remove as many callbacks as added through
* espi_add_callback().
*/
static inline int espi_remove_callback(struct device *dev,
struct espi_callback *callback)
{
const struct espi_driver_api *api =
(const struct espi_driver_api *)dev->driver_api;
if (!api->manage_callback) {
return -ENOTSUP;
}
return api->manage_callback(dev, callback, false);
}
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#include <syscalls/espi.h>
#endif /* ZEPHYR_INCLUDE_ESPI_H_ */
|