Files
OpenCellular/include/lpc.h
Randall Spangler f76cb374f8 Clean up LPC module
Tidied comments, and removed handling of ACPI events on host command
port (not needed since EVT hardware is now EOL'd).

BUG=chrome-os-partner:15579
BRANCH=none
TEST='ectool hello' succeeds

Change-Id: I063382b9981f713ba23f7714b4ccb7faa957b411
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://gerrit.chromium.org/gerrit/36804
2012-10-30 12:42:45 -07:00

92 lines
1.9 KiB
C

/* Copyright (c) 2012 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.
*/
/* LPC module for Chrome EC */
#ifndef __CROS_EC_LPC_H
#define __CROS_EC_LPC_H
#include "common.h"
/**
* Return a pointer to the memory-mapped buffer.
*
* This buffer is writable at any time, and the host can read it at any time.
*/
uint8_t *lpc_get_memmap_range(void);
/**
* Return true if keyboard data is waiting for the host to read (TOH is still
* set).
*/
int lpc_keyboard_has_char(void);
/**
* Send a byte to host via keyboard port 0x60.
*
* @param chr Byte to send
* @param send_irq If non-zero, asserts IRQ
*/
void lpc_keyboard_put_char(uint8_t chr, int send_irq);
/**
* Clear the keyboard buffer.
*/
void lpc_keyboard_clear_buffer(void);
/**
* Send an IRQ to host if there is a byte in buffer already.
*/
void lpc_keyboard_resume_irq(void);
/**
* Return non-zero if the COMx interface has received a character.
*/
int lpc_comx_has_char(void);
/**
* Return the next character pending on the COMx interface.
*/
int lpc_comx_get_char(void);
/**
* Put a character to the COMx LPC interface.
*/
void lpc_comx_put_char(int c);
/*
* Low-level LPC interface for host events.
*
* For use by host_event_commands.c. Other modules should use the methods
* provided in host_command.h.
*/
/* Types of host events */
enum lpc_host_event_type {
LPC_HOST_EVENT_SMI = 0,
LPC_HOST_EVENT_SCI,
LPC_HOST_EVENT_WAKE,
};
/**
* Set the event state.
*/
void lpc_set_host_event_state(uint32_t mask);
/**
* Set the event mask for the specified event type.
*
* @param type Event type
* @param mask New event mask
*/
void lpc_set_host_event_mask(enum lpc_host_event_type type, uint32_t mask);
/**
* Return the event mask for the specified event type.
*/
uint32_t lpc_get_host_event_mask(enum lpc_host_event_type type);
#endif /* __CROS_EC_LPC_H */