1 /* $OpenBSD: gscsio.c,v 1.3 2004/11/17 16:53:05 mickey Exp $ */ 2 /* 3 * Copyright (c) 2004 Alexander Yurchenko <grange@openbsd.org> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 */ 17 18 /* 19 * National Semiconductor Geode SC1100 Super I/O. 20 * Only ACCESS.bus logical device is supported. 21 */ 22 23 #include <sys/param.h> 24 #include <sys/systm.h> 25 #include <sys/device.h> 26 #include <sys/kernel.h> 27 #include <sys/lock.h> 28 #include <sys/proc.h> 29 30 #include <machine/bus.h> 31 32 #include <dev/i2c/i2cvar.h> 33 34 #include <dev/isa/isareg.h> 35 #include <dev/isa/isavar.h> 36 37 #include <dev/isa/gscsioreg.h> 38 39 struct gscsio_softc { 40 struct device sc_dev; 41 42 bus_space_tag_t sc_iot; 43 bus_space_handle_t sc_ioh; 44 45 int sc_ld_en[GSCSIO_LDNUM]; 46 bus_space_handle_t sc_ld_ioh0[GSCSIO_LDNUM]; 47 bus_space_handle_t sc_ld_ioh1[GSCSIO_LDNUM]; 48 49 /* ACCESS.bus */ 50 struct gscsio_acb { 51 void *sc; 52 bus_space_handle_t ioh; 53 struct lock buslock; 54 } sc_acb[2]; 55 struct i2c_controller sc_acb1_tag; 56 struct i2c_controller sc_acb2_tag; 57 }; 58 59 /* Supported logical devices description */ 60 static const struct { 61 const char *ld_name; 62 int ld_num; 63 int ld_iosize0; 64 int ld_iosize1; 65 } gscsio_ld[] = { 66 { "ACB1", GSCSIO_LDN_ACB1, 6, 0 }, 67 { "ACB2", GSCSIO_LDN_ACB2, 6, 0 }, 68 }; 69 70 int gscsio_probe(struct device *, void *, void *); 71 void gscsio_attach(struct device *, struct device *, void *); 72 73 void gscsio_acb_init(struct gscsio_acb *, i2c_tag_t); 74 int gscsio_acb_wait(struct gscsio_acb *, int, int); 75 void gscsio_acb_reset(struct gscsio_acb *acb); 76 77 int gscsio_acb_acquire_bus(void *, int); 78 void gscsio_acb_release_bus(void *, int); 79 int gscsio_acb_send_start(void *, int); 80 int gscsio_acb_send_stop(void *, int); 81 int gscsio_acb_initiate_xfer(void *, uint16_t, int); 82 int gscsio_acb_read_byte(void *, uint8_t *, int); 83 int gscsio_acb_write_byte(void *, uint8_t, int); 84 85 struct cfattach gscsio_ca = { 86 sizeof(struct gscsio_softc), 87 gscsio_probe, 88 gscsio_attach 89 }; 90 91 struct cfdriver gscsio_cd = { 92 NULL, "gscsio", DV_DULL 93 }; 94 95 #define ACB_READ(reg) \ 96 bus_space_read_1(sc->sc_iot, acb->ioh, (reg)) 97 #define ACB_WRITE(reg, val) \ 98 bus_space_write_1(sc->sc_iot, acb->ioh, (reg), (val)) 99 100 static __inline u_int8_t 101 idxread(bus_space_tag_t iot, bus_space_handle_t ioh, int idx) 102 { 103 bus_space_write_1(iot, ioh, GSCSIO_IDX, idx); 104 105 return (bus_space_read_1(iot, ioh, GSCSIO_DAT)); 106 } 107 108 static __inline void 109 idxwrite(bus_space_tag_t iot, bus_space_handle_t ioh, int idx, u_int8_t data) 110 { 111 bus_space_write_1(iot, ioh, GSCSIO_IDX, idx); 112 bus_space_write_1(iot, ioh, GSCSIO_DAT, data); 113 } 114 115 int 116 gscsio_probe(struct device *parent, void *match, void *aux) 117 { 118 struct isa_attach_args *ia = aux; 119 bus_space_tag_t iot; 120 bus_space_handle_t ioh; 121 int iobase; 122 int rv = 0; 123 124 iot = ia->ia_iot; 125 iobase = ia->ipa_io[0].base; 126 if (bus_space_map(iot, iobase, GSCSIO_IOSIZE, 0, &ioh)) 127 return (0); 128 if (idxread(iot, ioh, GSCSIO_ID) == GSCSIO_ID_SC1100) 129 rv = 1; 130 bus_space_unmap(iot, ioh, GSCSIO_IOSIZE); 131 132 if (rv) { 133 ia->ipa_nio = 1; 134 ia->ipa_io[0].length = GSCSIO_IOSIZE; 135 ia->ipa_nmem = 0; 136 ia->ipa_nirq = 0; 137 ia->ipa_ndrq = 0; 138 } 139 140 return (rv); 141 } 142 143 void 144 gscsio_attach(struct device *parent, struct device *self, void *aux) 145 { 146 struct gscsio_softc *sc = (void *)self; 147 struct isa_attach_args *ia = aux; 148 int i; 149 int iobase; 150 151 sc->sc_iot = ia->ia_iot; 152 if (bus_space_map(sc->sc_iot, ia->ipa_io[0].base, GSCSIO_IOSIZE, 153 0, &sc->sc_ioh)) { 154 printf(": can't map I/O space\n"); 155 return; 156 } 157 printf(": SC1100 SIO rev %d:", 158 idxread(sc->sc_iot, sc->sc_ioh, GSCSIO_REV)); 159 160 /* Configure all supported logical devices */ 161 for (i = 0; i < sizeof (gscsio_ld) / sizeof(gscsio_ld[0]); i++) { 162 sc->sc_ld_en[gscsio_ld[i].ld_num] = 0; 163 164 /* Select the device and check if it's activated */ 165 idxwrite(sc->sc_iot, sc->sc_ioh, GSCSIO_LDN, 166 gscsio_ld[i].ld_num); 167 if ((idxread(sc->sc_iot, sc->sc_ioh, GSCSIO_ACT) & 168 GSCSIO_ACT_EN) == 0) 169 continue; 170 171 /* Map I/O space 0 if necessary */ 172 if (gscsio_ld[i].ld_iosize0 != 0) { 173 iobase = idxread(sc->sc_iot, sc->sc_ioh, 174 GSCSIO_IO0_MSB); 175 iobase <<= 8; 176 iobase |= idxread(sc->sc_iot, sc->sc_ioh, 177 GSCSIO_IO0_LSB); 178 if (bus_space_map(sc->sc_iot, iobase, 179 gscsio_ld[i].ld_iosize0, 0, 180 &sc->sc_ld_ioh0[gscsio_ld[i].ld_num])) 181 continue; 182 } 183 184 /* Map I/O space 1 if necessary */ 185 if (gscsio_ld[i].ld_iosize1 != 0) { 186 iobase = idxread(sc->sc_iot, sc->sc_ioh, 187 GSCSIO_IO1_MSB); 188 iobase <<= 8; 189 iobase |= idxread(sc->sc_iot, sc->sc_ioh, 190 GSCSIO_IO1_LSB); 191 if (bus_space_map(sc->sc_iot, iobase, 192 gscsio_ld[i].ld_iosize1, 0, 193 &sc->sc_ld_ioh0[gscsio_ld[i].ld_num])) { 194 bus_space_unmap(sc->sc_iot, 195 sc->sc_ld_ioh0[gscsio_ld[i].ld_num], 196 gscsio_ld[i].ld_iosize0); 197 continue; 198 } 199 } 200 201 sc->sc_ld_en[gscsio_ld[i].ld_num] = 1; 202 printf(" %s", gscsio_ld[i].ld_name); 203 } 204 printf("\n"); 205 206 /* Initialize ACCESS.bus 1 */ 207 if (sc->sc_ld_en[GSCSIO_LDN_ACB1]) { 208 sc->sc_acb[0].sc = sc; 209 sc->sc_acb[0].ioh = sc->sc_ld_ioh0[GSCSIO_LDN_ACB1]; 210 lockinit(&sc->sc_acb[0].buslock, PRIBIO | PCATCH, 211 "iiclk", 0, 0); 212 gscsio_acb_init(&sc->sc_acb[0], &sc->sc_acb1_tag); 213 } 214 215 /* Initialize ACCESS.bus 2 */ 216 if (sc->sc_ld_en[GSCSIO_LDN_ACB2]) { 217 sc->sc_acb[1].sc = sc; 218 sc->sc_acb[1].ioh = sc->sc_ld_ioh0[GSCSIO_LDN_ACB2]; 219 lockinit(&sc->sc_acb[1].buslock, PRIBIO | PCATCH, 220 "iiclk", 0, 0); 221 gscsio_acb_init(&sc->sc_acb[1], &sc->sc_acb2_tag); 222 } 223 } 224 225 void 226 gscsio_acb_init(struct gscsio_acb *acb, i2c_tag_t tag) 227 { 228 struct gscsio_softc *sc = acb->sc; 229 struct i2cbus_attach_args iba; 230 231 /* Enable ACB and configure clock frequency */ 232 ACB_WRITE(GSCSIO_ACB_CTL2, GSCSIO_ACB_CTL2_EN | 233 (GSCSIO_ACB_FREQ << GSCSIO_ACB_CTL2_FREQ_SHIFT)); 234 235 /* Select polling mode */ 236 ACB_WRITE(GSCSIO_ACB_CTL1, ACB_READ(GSCSIO_ACB_CTL1) & 237 ~GSCSIO_ACB_CTL1_INTEN); 238 239 /* Disable slave address */ 240 ACB_WRITE(GSCSIO_ACB_ADDR, ACB_READ(GSCSIO_ACB_ADDR) & 241 ~GSCSIO_ACB_ADDR_SAEN); 242 243 /* Attach I2C framework */ 244 tag->ic_cookie = acb; 245 tag->ic_acquire_bus = gscsio_acb_acquire_bus; 246 tag->ic_release_bus = gscsio_acb_release_bus; 247 tag->ic_send_start = gscsio_acb_send_start; 248 tag->ic_send_stop = gscsio_acb_send_stop; 249 tag->ic_initiate_xfer = gscsio_acb_initiate_xfer; 250 tag->ic_read_byte = gscsio_acb_read_byte; 251 tag->ic_write_byte = gscsio_acb_write_byte; 252 253 iba.iba_name = "iic"; 254 iba.iba_tag = tag; 255 config_found(&sc->sc_dev, &iba, iicbus_print); 256 } 257 258 int 259 gscsio_acb_wait(struct gscsio_acb *acb, int bits, int flags) 260 { 261 struct gscsio_softc *sc = acb->sc; 262 u_int8_t st; 263 int i; 264 265 for (i = 0; i < 100; i++) { 266 st = ACB_READ(GSCSIO_ACB_ST); 267 if (st & GSCSIO_ACB_ST_BER) { 268 printf("%s: bus error, flags=0x%x\n", 269 sc->sc_dev.dv_xname, flags); 270 gscsio_acb_reset(acb); 271 return (EIO); 272 } 273 if (st & GSCSIO_ACB_ST_NEGACK) { 274 printf("%s: negative ack, flags=0x%x\n", 275 sc->sc_dev.dv_xname, flags); 276 gscsio_acb_reset(acb); 277 return (EIO); 278 } 279 if ((st & bits) == bits) 280 break; 281 delay(10); 282 } 283 if ((st & bits) != bits) { 284 printf("%s: timeout, flags=0x%x\n", 285 sc->sc_dev.dv_xname, flags); 286 gscsio_acb_reset(acb); 287 return (ETIMEDOUT); 288 } 289 290 return (0); 291 } 292 293 void 294 gscsio_acb_reset(struct gscsio_acb *acb) 295 { 296 struct gscsio_softc *sc = acb->sc; 297 u_int8_t st, ctl; 298 299 /* Clear MASTER, NEGACK and BER */ 300 st = ACB_READ(GSCSIO_ACB_ST); 301 st |= GSCSIO_ACB_ST_MASTER | GSCSIO_ACB_ST_NEGACK | GSCSIO_ACB_ST_BER; 302 ACB_WRITE(GSCSIO_ACB_ST, st); 303 304 /* Disable and re-enable ACB */ 305 ACB_WRITE(GSCSIO_ACB_CTL2, 0); 306 ACB_WRITE(GSCSIO_ACB_CTL2, GSCSIO_ACB_CTL2_EN | 307 (GSCSIO_ACB_FREQ << GSCSIO_ACB_CTL2_FREQ_SHIFT)); 308 309 /* Send stop */ 310 ctl = ACB_READ(GSCSIO_ACB_CTL1); 311 ctl |= GSCSIO_ACB_CTL1_STOP; 312 ACB_WRITE(GSCSIO_ACB_CTL1, ctl); 313 } 314 315 int 316 gscsio_acb_acquire_bus(void *cookie, int flags) 317 { 318 struct gscsio_acb *acb = cookie; 319 320 if (flags & I2C_F_POLL) 321 return (0); 322 323 return (lockmgr(&acb->buslock, LK_EXCLUSIVE, NULL, curproc)); 324 } 325 326 void 327 gscsio_acb_release_bus(void *cookie, int flags) 328 { 329 struct gscsio_acb *acb = cookie; 330 331 if (flags & I2C_F_POLL) 332 return; 333 334 lockmgr(&acb->buslock, LK_RELEASE, NULL, curproc); 335 } 336 337 int 338 gscsio_acb_send_start(void *cookie, int flags) 339 { 340 struct gscsio_acb *acb = cookie; 341 struct gscsio_softc *sc = acb->sc; 342 u_int8_t ctl; 343 344 ctl = ACB_READ(GSCSIO_ACB_CTL1); 345 ctl |= GSCSIO_ACB_CTL1_START; 346 ACB_WRITE(GSCSIO_ACB_CTL1, ctl); 347 348 return (0); 349 } 350 351 int 352 gscsio_acb_send_stop(void *cookie, int flags) 353 { 354 struct gscsio_acb *acb = cookie; 355 struct gscsio_softc *sc = acb->sc; 356 u_int8_t ctl; 357 358 ctl = ACB_READ(GSCSIO_ACB_CTL1); 359 ctl |= GSCSIO_ACB_CTL1_STOP; 360 ACB_WRITE(GSCSIO_ACB_CTL1, ctl); 361 362 return (0); 363 } 364 365 int 366 gscsio_acb_initiate_xfer(void *cookie, uint16_t addr, int flags) 367 { 368 struct gscsio_acb *acb = cookie; 369 struct gscsio_softc *sc = acb->sc; 370 u_int8_t ctl; 371 int dir; 372 int error; 373 374 /* Issue start condition */ 375 ctl = ACB_READ(GSCSIO_ACB_CTL1); 376 ctl |= GSCSIO_ACB_CTL1_START; 377 ACB_WRITE(GSCSIO_ACB_CTL1, ctl); 378 379 /* Wait for bus mastership */ 380 if ((error = gscsio_acb_wait(acb, 381 GSCSIO_ACB_ST_MASTER | GSCSIO_ACB_ST_SDAST, flags))) 382 return (error); 383 384 /* Send address byte */ 385 dir = (flags & I2C_F_READ ? 1 : 0); 386 ACB_WRITE(GSCSIO_ACB_SDA, (addr << 1) | dir); 387 388 return (0); 389 } 390 391 int 392 gscsio_acb_read_byte(void *cookie, uint8_t *bytep, int flags) 393 { 394 struct gscsio_acb *acb = cookie; 395 struct gscsio_softc *sc = acb->sc; 396 u_int8_t ctl; 397 int error; 398 399 /* Wait for the bus to be ready */ 400 if ((error = gscsio_acb_wait(acb, GSCSIO_ACB_ST_SDAST, flags))) 401 return (error); 402 403 /* Acknowledge the last byte */ 404 if (flags & I2C_F_LAST) { 405 ctl = ACB_READ(GSCSIO_ACB_CTL1); 406 ctl |= GSCSIO_ACB_CTL1_ACK; 407 ACB_WRITE(GSCSIO_ACB_CTL1, ctl); 408 } 409 410 /* Read data byte */ 411 *bytep = ACB_READ(GSCSIO_ACB_SDA); 412 413 return (0); 414 } 415 416 int 417 gscsio_acb_write_byte(void *cookie, uint8_t byte, int flags) 418 { 419 struct gscsio_acb *acb = cookie; 420 struct gscsio_softc *sc = acb->sc; 421 u_int8_t ctl; 422 int error; 423 424 /* Wait for the bus to be ready */ 425 if ((error = gscsio_acb_wait(acb, GSCSIO_ACB_ST_SDAST, flags))) 426 return (error); 427 428 /* Send stop after the last byte */ 429 if (flags & I2C_F_STOP) { 430 ctl = ACB_READ(GSCSIO_ACB_CTL1); 431 ctl |= GSCSIO_ACB_CTL1_STOP; 432 ACB_WRITE(GSCSIO_ACB_CTL1, ctl); 433 } 434 435 /* Write data byte */ 436 ACB_WRITE(GSCSIO_ACB_SDA, byte); 437 438 return (0); 439 } 440